Create New Project
POST/v1/project/create
Create a project associated with an organization.
Request
- application/json
Body
required
- MOD1
- MOD1
- MOD1
- MOD1
- MOD1
organization_id Organization Id (string)required
Unique organization id
project_name Project Name (string)required
The name of the project
modality
object
The data modality of this project. DEPRECATED.
anyOf
string
unique_id_field
object
DEPRECATED: The unique ID field of the project.
anyOf
string
description Description (string)
A description of your project.
is_public Is Public (boolean)
Is the project public?
is_public_to_org
object
Is the project public to the organization?
anyOf
boolean
slug
object
The desired url slug for the project
anyOf
string
privacy
object
The privacy of the project
anyOf
string
Possible values: [public, with_link, private, restricted]
Responses
- 201
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
project_id Project Id (string)required
The ID of the newly created project
slug Slug (string)required
The unique url slug of the project
{
"project_id": "string",
"slug": "string"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...