Documentation menu

Projects

47 operations.

MethodEndpointDescription
GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentialsList provider credentials
POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentialsCreate a provider credential
GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}Get a provider credential
PATCH/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}Update a provider credential
DELETE/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}Delete a provider credential
POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}/versionsRotate a provider credential
GET/api/v1/projectsList projects
POST/api/v1/projectsCreate a project
GET/api/v1/projects/{projectId}Get a project
PATCH/api/v1/projects/{projectId}Update a project
DELETE/api/v1/projects/{projectId}Request project deletion
GET/api/v1/projects/{projectId}/agentsList project agents
POST/api/v1/projects/{projectId}/agentsCreate a project agent
GET/api/v1/projects/{projectId}/agents/{agentId}Get a project agent
PATCH/api/v1/projects/{projectId}/agents/{agentId}Update a project agent
DELETE/api/v1/projects/{projectId}/agents/{agentId}Delete a project agent
GET/api/v1/projects/{projectId}/agents/{agentId}/revisionsList Agent revisions
POST/api/v1/projects/{projectId}/agents/{agentId}/revisionsCreate an Agent revision
GET/api/v1/projects/{projectId}/agents/{agentId}/revisions/{agentRevisionId}Get an Agent revision
GET/api/v1/projects/{projectId}/environmentsList project environments
POST/api/v1/projects/{projectId}/environmentsCreate a custom project environment
GET/api/v1/projects/{projectId}/environments/{environmentId}Get project environment
PATCH/api/v1/projects/{projectId}/environments/{environmentId}Update project environment
DELETE/api/v1/projects/{projectId}/environments/{environmentId}Delete custom project environment
GET/api/v1/projects/{projectId}/environments/{environmentId}/activationGet active deployment
GET/api/v1/projects/{projectId}/environments/{environmentId}/activationsList activation history
POST/api/v1/projects/{projectId}/environments/{environmentId}/activationsActivate deployment
GET/api/v1/projects/{projectId}/environments/{environmentId}/activations/{activationId}Get an activation
GET/api/v1/projects/{projectId}/environments/{environmentId}/deploymentsList deployments
POST/api/v1/projects/{projectId}/environments/{environmentId}/deploymentsCreate a deployment
GET/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}Get deployment
PATCH/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}Cancel a deployment
POST/api/v1/projects/{projectId}/environments/{environmentId}/operations/{definitionIdOrName}/invocationsInvoke an operation
POST/api/v1/projects/{projectId}/environments/{environmentId}/presentations/{definitionIdOrName}/rendersRender a deployed presentation
GET/api/v1/projects/{projectId}/membersList Project members
POST/api/v1/projects/{projectId}/membersAdd a Project member
PATCH/api/v1/projects/{projectId}/members/{userId}Update a Project member role
DELETE/api/v1/projects/{projectId}/members/{userId}Remove a Project member
GET/api/v1/projects/{projectId}/releasesList project releases
POST/api/v1/projects/{projectId}/releasesCreate project release
GET/api/v1/projects/{projectId}/releases/{releaseId}Get project release
GET/api/v1/projects/{projectId}/user-groupsList Project user-group grants
POST/api/v1/projects/{projectId}/user-groupsGrant a Project user group access
PATCH/api/v1/projects/{projectId}/user-groups/{userGroupId}Update a Project user-group grant
DELETE/api/v1/projects/{projectId}/user-groups/{userGroupId}Remove a Project user-group grant
GET/api/v1/users/{userId}Get a user
PATCH/api/v1/users/{userId}Update own user profile

List provider credentials

GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentials

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to List provider credentials.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create a provider credential

POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentials

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to Create a provider credential.

Request body

required — Request body for: Create a provider credential.

application/json

NameTypeRequiredDescription
labelstringrequired
providerone of 2 typesrequired
credentialType"api_key" | "oauth" | "service_account" | "connection_string"required
secretstringrequired
expiresAtone of 2 typesoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get a provider credential

GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to Get a provider credential.
credentialIdstringrequiredIdentifies the provider credential being addressed. Applies to Get a provider credential.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update a provider credential

PATCH/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to Update a provider credential.
credentialIdstringrequiredIdentifies the provider credential being addressed. Applies to Update a provider credential.

Request body

required — Request body for: Update a provider credential.

application/json

NameTypeRequiredDescription
labelstringoptional
status"active" | "disabled" | "deleting"optional
expiresAtone of 2 typesoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Delete a provider credential

DELETE/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to Delete a provider credential.
credentialIdstringrequiredIdentifies the provider credential being addressed. Applies to Delete a provider credential.

Responses

StatusDescriptionBody
200Response for status 200
type
none
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Rotate a provider credential

POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}/versions

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugstringrequiredIdentifies the organization by its stable identifier or slug. Applies to Rotate a provider credential.
credentialIdstringrequiredIdentifies the provider credential being addressed. Applies to Rotate a provider credential.

Request body

required — Request body for: Rotate a provider credential.

application/json

NameTypeRequiredDescription
secretstringrequired

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List projects

GET/api/v1/projects

Parameters

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List projects.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List projects.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
  • pagination (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create a project

POST/api/v1/projects

Request body

required — Request body for: Create a project.

application/json

NameTypeRequiredDescription
slugstringrequired
namestringrequired
templateIdstringoptional

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • type (required): "project"
  • id (required): string
  • organizationId (required): string
  • slug (required): string
  • name (required): string
  • status (required): "provisioning" | "active" | "paused" | "deleting"
  • role (optional): "admin" | "developer" | "viewer"
  • createdAt (required): string
  • updatedAt (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get a project

GET/api/v1/projects/{projectId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get a project.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update a project

PATCH/api/v1/projects/{projectId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update a project.

Request body

required — Request body for: Update a project.

application/json

NameTypeRequiredDescription
namestringoptional
slugstringoptional
status"active" | "paused"optional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Request project deletion

DELETE/api/v1/projects/{projectId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Request project deletion.

Responses

StatusDescriptionBody
202Response for status 202
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.
application/json
PublicApiError
  • error (required): object

List project agents

GET/api/v1/projects/{projectId}/agents

Returns the canonical Agents owned by this Project with cursor pagination.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List project agents.

query

NameTypeRequiredDescription
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List project agents.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List project agents.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • agents (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create a project agent

POST/api/v1/projects/{projectId}/agents

Creates a Project Agent identity. Publish an immutable Agent revision separately before selecting it for a Release.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create a project agent.

Request body

required — Request body for: Create a project agent.

application/json

NameTypeRequiredDescription
slugstringrequired
namestringrequired
descriptionstringoptional

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • type (required): "agent"
  • id (required): string
  • slug (required): string
  • name (required): string
  • description (optional): string
  • status (required): "draft" | "active" | "paused" | "deleting"
  • createdAt (required): string
  • updatedAt (required): string
  • scope (required): "project"
  • projectId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get a project agent

GET/api/v1/projects/{projectId}/agents/{agentId}

Returns one canonical Project Agent identity and its lifecycle status within the requested Project.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get a project agent.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Get a project agent.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • type (required): "agent"
  • id (required): string
  • slug (required): string
  • name (required): string
  • description (optional): string
  • status (required): "draft" | "active" | "paused" | "deleting"
  • createdAt (required): string
  • updatedAt (required): string
  • scope (required): "project"
  • projectId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update a project agent

PATCH/api/v1/projects/{projectId}/agents/{agentId}

Updates the Project Agent display metadata. Immutable Agent revisions and their content are not changed by this request.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update a project agent.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Update a project agent.

Request body

required — Request body for: Update a project agent.

application/json

NameTypeRequiredDescription
namestringoptional
descriptionone of 2 typesoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • type (required): "agent"
  • id (required): string
  • slug (required): string
  • name (required): string
  • description (optional): string
  • status (required): "draft" | "active" | "paused" | "deleting"
  • createdAt (required): string
  • updatedAt (required): string
  • scope (required): "project"
  • projectId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Delete a project agent

DELETE/api/v1/projects/{projectId}/agents/{agentId}

Queues deletion of the Project Agent and returns 202 with the canonical resource. Deletion is rejected with 409 while an active Deployment, enabled Agent Job, non-terminal AgentRun, or live delegation depends on the Agent.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Delete a project agent.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Delete a project agent.

Responses

StatusDescriptionBody
202Response for status 202
application/json
object
  • agent (required): object
  • deleting (required): true
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List Agent revisions

GET/api/v1/projects/{projectId}/agents/{agentId}/revisions

Lists immutable revisions for the canonical Project Agent. Cursors continue the same Project and Agent scope.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List Agent revisions.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to List Agent revisions.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List Agent revisions.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List Agent revisions.

Responses

StatusDescriptionBody
200Response for status 200
application/json
getApiV1ProjectsByProjectIdAgentsByAgentIdRevisions
  • revisions (required): array<object>
  • pagination (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create an Agent revision

POST/api/v1/projects/{projectId}/agents/{agentId}/revisions

Creates one immutable Agent revision. The returned revision ID is the exact pin accepted by Release creation; it does not silently follow a later revision.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create an Agent revision.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Create an Agent revision.

Request body

required — Request body for: Create an Agent revision.

application/json

NameTypeRequiredDescription
contentobjectrequired
grantedOperationsarray<"agents:invoke-operation" | "agents:manage-workflows" | "agents:render-presentation" | "projects:list" | "projects:get" | "projects:create" | "projects:update" | "projects:delete" | "projects:read-runtime-data" | "analytics:read" | "projects:manage-access-grants" | "deployments:create" | "activations:create" | "env:variables:list" | "env:variables:get" | "env:variables:create" | "env:variables:update" | "env:variables:delete" | "provider-credentials:list" | "provider-credentials:get" | "provider-credentials:create" | "provider-credentials:update" | "provider-credentials:delete" | "provider-credentials:versions:create" | "organizations:get" | "organizations:delete" | "organizations:update" | "organizations:manage-user-groups" | "organizations:manage-members" | "organization-integrations:list" | "organization-integrations:get" | "organization-integrations:create" | "organization-integrations:update" | "organization-integrations:delete" | "organization-integrations:verify" | "organization-integrations:presets:list" | "organization-variables:list" | "organization-variables:manage" | "connections:list" | "connections:get" | "connections:create" | "connections:update" | "connections:delete" | "connections:start-oauth" | "connections:presets:list" | "api-keys:list" | "api-keys:get" | "api-keys:create" | "api-keys:update" | "api-keys:revoke" | "definitions:list" | "definitions:get" | "definitions:create" | "definitions:update" | "definitions:delete" | "operation-invocations:list" | "operation-approvals:list" | "operation-approvals:approve" | "operation-approvals:reject" | "agents:get" | "agents:list" | "agents:revisions:create" | "agents:revisions:get" | "agents:revisions:list" | "agents:delete" | "agents:push" | "agent-runs:cancel" | "agent-runs:continue" | "agent-runs:create" | "agent-runs:personalize" | "agent-runs:get" | "agent-runs:list" | "agent-runs:stream" | "agent-runs:update" | "agent-runs:steps:create" | "agent-runs:steps:get" | "agent-runs:steps:list" | "agent-runs:steps:checkpoints:create" | "agent-runs:steps:checkpoints:get" | "agent-runs:checkpoints:list" | "agent-runs:attempts:complete" | "agent-runs:attempts:heartbeat" | "agent-jobs:list" | "agent-jobs:get" | "agent-jobs:create" | "agent-jobs:update" | "agent-jobs:delete" | "agent-jobs:run-now" | "webhooks:list" | "webhooks:create" | "webhooks:delete" | "webhooks:rotate-secret" | "webhooks:replay" | "webhooks:retry-dead" | "webhooks:rebaseline" | "webhooks:events:read" | "templates:search" | "templates:read" | "billing:read" | "billing:manage">optional

Responses

StatusDescriptionBody
201Response for status 201
application/json
postApiV1ProjectsByProjectIdAgentsByAgentIdRevisions
  • type (required): "agentRevision"
  • id (required): string
  • agentId (required): string
  • revisionNumber (required): integer
  • content (required): object
  • grantedOperations (required): array<string>
  • createdBy (required): string
  • createdAt (required): string
  • contentDigest (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get an Agent revision

GET/api/v1/projects/{projectId}/agents/{agentId}/revisions/{agentRevisionId}

Returns the exact immutable Agent revision identified by the URL, without resolving the Agent's latest revision or merging another Agent.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get an Agent revision.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Get an Agent revision.
agentRevisionIdstringrequiredIdentifies the immutable Project Agent revision being addressed. Applies to Get an Agent revision.

Responses

StatusDescriptionBody
200Response for status 200
application/json
getApiV1ProjectsByProjectIdAgentsByAgentIdRevisionsByAgentRevisionId
  • type (required): "agentRevision"
  • id (required): string
  • agentId (required): string
  • revisionNumber (required): integer
  • content (required): object
  • grantedOperations (required): array<string>
  • createdBy (required): string
  • createdAt (required): string
  • contentDigest (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List project environments

GET/api/v1/projects/{projectId}/environments

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List project environments.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create a custom project environment

POST/api/v1/projects/{projectId}/environments

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create a custom project environment.

Request body

required — Request body for: Create a custom project environment.

application/json

NameTypeRequiredDescription
slugstringrequired
displayNamestringrequired

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get project environment

GET/api/v1/projects/{projectId}/environments/{environmentId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get project environment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Get project environment.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update project environment

PATCH/api/v1/projects/{projectId}/environments/{environmentId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update project environment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Update project environment.

Request body

required — Request body for: Update project environment.

application/json

NameTypeRequiredDescription
lifecycle"provisioning" | "active" | "paused" | "deleting"optional
expectedLifecycle"provisioning" | "active" | "paused" | "deleting"optional
slugstringoptional
displayNamestringoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Delete custom project environment

DELETE/api/v1/projects/{projectId}/environments/{environmentId}

Marks a custom Project Environment for deletion and queues exact owned runtime cleanup. Built-in development, preview, and production Environments are protected and return 409. The response is an asynchronous deletion receipt; it does not claim that provider cleanup has already finished.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Delete custom project environment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Delete custom project environment.

Responses

StatusDescriptionBody
202Response for status 202
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.
application/json
PublicApiError
  • error (required): object

Get active deployment

GET/api/v1/projects/{projectId}/environments/{environmentId}/activation

Returns the current active Deployment coordinate for this Environment, including its Release and configuration revision. A valid Environment with no active Deployment returns 404; no provider or runtime locator is exposed.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get active deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Get active deployment.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • activationId (required): string
  • deploymentId (required): string
  • generation (required): integer
  • environmentId (required): string
  • projectId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List activation history

GET/api/v1/projects/{projectId}/environments/{environmentId}/activations

Lists immutable activation records for one exact Project Environment. Use pagination.nextCursor for the next page; the cursor is opaque and bound to this Project/Environment. A missing or inaccessible coordinate is 404, and malformed pagination is 422.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List activation history.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to List activation history.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List activation history.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List activation history.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • activations (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Activate deployment

POST/api/v1/projects/{projectId}/environments/{environmentId}/activations

Synchronously activates an eligible ready Deployment and atomically advances this Environment's active pointer and generation. The expectedGeneration field is a compare-and-set guard; non-ready or stale/conflicting requests return 409, while a missing or foreign Project/Environment/Deployment coordinate returns 404.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Activate deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Activate deployment.

Request body

required — Request body for: Activate deployment.

application/json

NameTypeRequiredDescription
deploymentIdstringrequired
expectedGenerationintegerrequired

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • activationId (required): string
  • deploymentId (required): string
  • generation (required): integer
  • environmentId (required): string
  • projectId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get an activation

GET/api/v1/projects/{projectId}/environments/{environmentId}/activations/{activationId}

Returns one immutable Activation for the exact Project Environment coordinate. The response includes the pinned Deployment, Release, configuration revision, generation, actor, and timestamps; an unknown or foreign activation is 404.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get an activation.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Get an activation.
activationIdstringrequiredIdentifies the Project Environment activation being addressed. Applies to Get an activation.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • activationId (required): string
  • deploymentId (required): string
  • generation (required): integer
  • environmentId (required): string
  • projectId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List deployments

GET/api/v1/projects/{projectId}/environments/{environmentId}/deployments

Lists Deployments belonging to the exact Project Environment coordinate. Deployment execution state is reported by the returned lifecycle status.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List deployments.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to List deployments.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List deployments.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List deployments.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • deployments (required): array<object>
  • pagination (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create a deployment

POST/api/v1/projects/{projectId}/environments/{environmentId}/deployments

Submits a Deployment using an existing immutable Release and the Environment's existing configuration revision head. Artifact validation occurs before the durable submission; execution is queued asynchronously. Reuse the same Idempotency-Key and payload to safely retry. A mismatched key returns 409, an in-progress claim may return 503 with Retry-After, and missing or incompatible pins return 404 or 422.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create a deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Create a deployment.

header

NameTypeRequiredDescription
Idempotency-Keystringrequired

Request body

required — Request body for: Create a deployment.

application/json

NameTypeRequiredDescription
releaseIdstringoptionalImmutable Release whose exact Agent and Definition revision pins will be deployed.
configurationRevisionIdstringrequiredExisting immutable configuration revision head for this Project Environment.
sourceReleaseIdstringoptional
expectedActiveDeploymentIdstringoptional
reasonstringoptional

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • type (required): "deployment"
  • id (required): string
  • projectId (required): string
  • environmentId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
  • status (required): "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled"
  • diagnostics (required): one of 2 types
  • createdAt (required): string
  • updatedAt (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.
application/json
PublicApiError
  • error (required): object

Get deployment

GET/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}

Returns one Deployment for the exact Project and Environment coordinate, including its immutable Release and configuration revision pins.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Get deployment.
deploymentIdstringrequiredIdentifies the Project Deployment being addressed. Applies to Get deployment.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • type (required): "deployment"
  • id (required): string
  • projectId (required): string
  • environmentId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
  • status (required): "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled"
  • diagnostics (required): one of 2 types
  • createdAt (required): string
  • updatedAt (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Cancel a deployment

PATCH/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}

Requests terminal cancellation with an expected-state CAS. Existing materialized resources are retained for cleanup.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Cancel a deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Cancel a deployment.
deploymentIdstringrequiredIdentifies the Project Deployment being addressed. Applies to Cancel a deployment.

Request body

required — Request body for: Cancel a deployment.

application/json

NameTypeRequiredDescription
status"canceled"required
expectedStatus"queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled"optional
reasonstringrequired

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • type (required): "deployment"
  • id (required): string
  • projectId (required): string
  • environmentId (required): string
  • releaseId (required): string
  • configurationRevisionId (required): string
  • status (required): "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled"
  • diagnostics (required): one of 2 types
  • createdAt (required): string
  • updatedAt (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Invoke an operation

POST/api/v1/projects/{projectId}/environments/{environmentId}/operations/{definitionIdOrName}/invocations

Execute an operation from the selected deployment. Definition data constraint failures return 422 with details.invocationId and a safe details.diagnostic. Inspect persisted diagnostics through the operation invocation list. A required auto-managed field must be included in the deployed domain's auto declarations; it must not be supplied manually. Infrastructure failures remain server errors, not input validation errors.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Invoke an operation.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Invoke an operation.
definitionIdOrNameone of 2 typesrequiredIdentifies the definition element by its stable identifier or name. Applies to Invoke an operation.

Request body

required — Request body for: Invoke an operation.

application/json

NameTypeRequiredDescription
agentIdstringrequired
paramsobjectoptional
actorUserIdstringoptional
approvalIdstringoptional
requestKeystringoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
postApiV1ProjectsByProjectIdEnvironmentsByEnvironmentIdOperationsByDefinitionIdOrNameInvocations
202Response for status 202
application/json
object
  • invocationId (required): string
  • outcome (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Render a deployed presentation

POST/api/v1/projects/{projectId}/environments/{environmentId}/presentations/{definitionIdOrName}/renders

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Render a deployed presentation.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Render a deployed presentation.
definitionIdOrNameone of 2 typesrequiredIdentifies the definition element by its stable identifier or name. Applies to Render a deployed presentation.

Request body

required — Request body for: Render a deployed presentation.

application/json

NameTypeRequiredDescription
agentIdstringrequired
paramsobjectoptional
actorUserIdstringoptional
requestKeystringoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
postApiV1ProjectsByProjectIdEnvironmentsByEnvironmentIdPresentationsByDefinitionIdOrNameRenders
  • data (required): object
400Bad Request
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List Project members

GET/api/v1/projects/{projectId}/members

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List Project members.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List Project members.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List Project members.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • members (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Add a Project member

POST/api/v1/projects/{projectId}/members

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Add a Project member.

Request body

required — Request body for: Add a Project member.

application/json

NameTypeRequiredDescription
userIdstringrequired
role"admin" | "developer" | "viewer"required

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • member (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update a Project member role

PATCH/api/v1/projects/{projectId}/members/{userId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update a Project member role.
userIdstringrequiredIdentifies the user whose membership or grant is being addressed. Applies to Update a Project member role.

Request body

required — Request body for: Update a Project member role.

application/json

NameTypeRequiredDescription
role"admin" | "developer" | "viewer"required

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • member (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Remove a Project member

DELETE/api/v1/projects/{projectId}/members/{userId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Remove a Project member.
userIdstringrequiredIdentifies the user whose membership or grant is being addressed. Applies to Remove a Project member.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • removed (required): true
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List project releases

GET/api/v1/projects/{projectId}/releases

Lists immutable Releases belonging to the Project. Each Release records the exact Agent and Definition revision pins used to build it.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List project releases.

query

NameTypeRequiredDescription
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List project releases.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List project releases.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • releases (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create project release

POST/api/v1/projects/{projectId}/releases

Creates an immutable Release from the explicitly supplied Agent and Definition revision IDs. The server validates the complete pin and delegate graph before accepting the Release.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create project release.

Request body

required — Request body for: Create project release.

application/json

NameTypeRequiredDescription
agentRevisionsarray<object>required
definitionRevisionsarray<object>required

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • id (required): string
  • projectId (required): string
  • manifest (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get project release

GET/api/v1/projects/{projectId}/releases/{releaseId}

Returns one immutable Project Release and its revision-pinned manifest; it does not expose provider locators or internal storage details.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get project release.
releaseIdstringrequiredIdentifies the immutable Project Release being addressed. Applies to Get project release.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • id (required): string
  • projectId (required): string
  • manifest (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

List Project user-group grants

GET/api/v1/projects/{projectId}/user-groups

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List Project user-group grants.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List Project user-group grants.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List Project user-group grants.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • grants (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Grant a Project user group access

POST/api/v1/projects/{projectId}/user-groups

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Grant a Project user group access.

Request body

required — Request body for: Grant a Project user group access.

application/json

NameTypeRequiredDescription
userGroupIdstringrequired
role"admin" | "developer" | "viewer"required

Responses

StatusDescriptionBody
201Response for status 201
application/json
object
  • grant (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update a Project user-group grant

PATCH/api/v1/projects/{projectId}/user-groups/{userGroupId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update a Project user-group grant.
userGroupIdstringrequiredIdentifies the Organization or Project user group being addressed. Applies to Update a Project user-group grant.

Request body

required — Request body for: Update a Project user-group grant.

application/json

NameTypeRequiredDescription
role"admin" | "developer" | "viewer"required

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • grant (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Remove a Project user-group grant

DELETE/api/v1/projects/{projectId}/user-groups/{userGroupId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Remove a Project user-group grant.
userGroupIdstringrequiredIdentifies the Organization or Project user group being addressed. Applies to Remove a Project user-group grant.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • removed (required): true
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get a user

GET/api/v1/users/{userId}

Parameters

path

NameTypeRequiredDescription
userIdstringrequiredIdentifies the user whose membership or grant is being addressed. Applies to Get a user.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Update own user profile

PATCH/api/v1/users/{userId}

Parameters

path

NameTypeRequiredDescription
userIdstringrequiredIdentifies the user whose membership or grant is being addressed. Applies to Update own user profile.

Request body

required — Request body for: Update own user profile.

application/json

NameTypeRequiredDescription
namestringoptional
imageone of 2 typesoptional

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • data (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object