Skip to content

Management API

Build and operate agents through Cantora

Use the Management API to create Projects and Environments, publish immutable Agent Versions, and activate Agent Releases.

Build your first Test Agent

Follow the ordered customer workflow from an issued credential through a Project, immutable Agent Version, and active Test Agent Release.

Start the quickstart.

Call the API safely

Learn how to handle a ServicePrincipal API key and how to distinguish authentication, authorization, validation, conflict, and concurrency failures.

Read Authentication and Errors.

Understand the resource model

Learn how Organizations, Projects, Environments, Tenants, and Users establish scope, and how Agent Definitions become immutable Agent Versions and explicit Agent Releases.

Read the resource model, then learn how Agent Configuration becomes an explicit release.

Make your first request

Put the API key Cantora issued in the CANTORA_API_KEY environment variable. Keep the credential out of source code, command history, and committed configuration.

TerminalReturns your ServicePrincipal identity
curl --fail-with-body https://api.cantora.ai/v1/identity \
  --header "Authorization: Bearer ${CANTORA_API_KEY}"

A successful response identifies the authenticated ServicePrincipal and the Organization it belongs to. Use that Organization identifier as the root of subsequent resource requests.

Inspect the contract

The complete OpenAPI 3.1 contract is available without a credential at api.cantora.ai/docs/openapi.json. It defines every path, schema, status, and bearer-authentication requirement accepted by this API revision.