Skip to main content
POST
Create a new workspace project.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Project creation parameters

Request body for creating a project

companyId
string
required

Company ID

name
string
required

Project name

description
string

Project description

instructions
string

Custom AI instructions

settings
object

Additional project settings

sharing
string
default:Private

Sharing mode: 'Private' or 'Shared'

Response

Created project

Project object

companyId
string

Company ID

created
number

Creation timestamp

description
string

Project description

id
string

Project ID

instructions
string

Custom AI instructions

name
string

Project name

settings
object

Additional project settings

sharing
string

Sharing mode: 'Private' or 'Shared'

uid
string

Owner user ID

updated
number

Last update timestamp