Skip to main content
POST
Create canvas

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

write

Grants write access

Body

application/json

Create a Canvas.

title
string
required

The title of the Canvas.

prompt
string
required

The prompt used to generate the Canvas.

workspace_token
string

The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.

Response

Canvas model

token
string
required
Example:

"cnvs_abcd1234567890"

title
string
required

The title of the Canvas.

Example:

"Weekly Spend by Team"

prompt
string
required

The prompt used to generate the Canvas.

workspace_token
string
required

The token for the Workspace the Canvas belongs to.

Example:

"wrkspc_abcd1234567890"

created_at
string
required

The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.

Example:

"2024-01-01T00:00:00Z"

updated_at
string
required

The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.

Example:

"2024-01-01T00:00:00Z"

data
object