Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Platform API

Use the Platform API to create, deploy, and operate agents from scripts and external tools. The base URL is https://api.amodalai.com.

Authenticate with a platform automation token:

Authorization: Bearer pk_...

Each operation lists the token kinds it accepts: observer, operator, or admin. A platform automation token does not authorize runtime chat; mint a runtime token with POST /api/agents/{agent_id}/tokens.

Download The Reference

The docs build generates the reference from the Platform API's endpoint metadata:

curl -fsSL https://docs.amodalai.com/openapi.json -o amodal-openapi.json

The OpenAPI document covers supported automation endpoints, accepted token kinds, and documented parameters and request bodies. Its success responses use generic object schemas. Check the actual HTTP status and returned JSON when handling a response.

See Build With A Coding Agent for setup and Deployment API for a release workflow.