Skip to content

Create project

POST
/api/v1/organizations/{orgId}/projects
curl --request POST \
--url https://localhost:10001/api/v1/organizations/example/projects \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example", "name": "example" }'

Create a new project under an organization and add the creating user as project owner

orgId
required
string

Organization ID or UUID (urn:uuid optional)

Project data

Media type application/json
object
description
required
string
name
required
string
Example generated
{
"description": "example",
"name": "example"
}

Created project

Media type application/json

An AI initiative within an organization, and the scope most access is granted against

object
archivedAt

Set via the archive endpoint

string format: date-time
createdAt
string format: date-time
description
string
id
integer
isArchived

Set via the archive endpoint

boolean
name
string
organizationId

Taken from the path on create

integer
slug

Derived from name

string
updatedAt
string format: date-time
uuid

Urn:uuid form

string
Example generated
{
"description": "example",
"name": "example"
}

Bad request - Invalid organization ID or request body

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Forbidden - No organization access or insufficient permissions

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Organization not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Name or URL already taken in this organization

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}