Skip to main content

​
Developer Platform API

The CREAO Developer Platform API lets you create, update, and run personal CREAO agents from your backend services. Use it for automation jobs, product workflows, internal tools, and user-facing experiences that need a hosted cloud agent runtime. Developer API v1 is served from: 
https://developer.creao.ai
All public API routes use Account API keys from Developer Console. Keys start with cr_sk_ and are sent as bearer tokens.
CREAO also supports app-scoped API Trigger keys created from an agent detail page in agent.creao.ai. Those keys start with capi_ and call agent.creao.ai/api/v1/apps/{appId}/runs. This API Reference covers the Developer Platform /v1/* endpoints; see API Trigger and API Paths for the side-by-side model.

​
What you can build

  • Background automation - run agents for reports, research, monitoring, and content operations.
  • Product features - stream agent output into your own product with realtime runs.
  • Backend integrations - trigger existing CREAO agents from scripts, CI jobs, queues, and webhooks.
  • Reusable workflows - keep agent setup, runtime state, tools, and files inside CREAO while your app sends structured inputs.

​
Core concepts

ConceptMeaning
Account API keyServer-side key from Developer Console. Keys start with cr_sk_.
agent_idPersonal CREAO agent you own. Create one through /v1/agents or copy it from Developer Console > Agents.
run_idDeveloper API run record. Use it to fetch status, result, usage, and errors.
conversation_idOpaque CREAO conversation ID. Reuse it to continue context across runs.

​
Run modes

Async runs

Create background runs with POST /v1/runs, poll by run_id, list recent runs, or receive terminal webhooks.

Realtime runs

Create streamed runs with POST /v1/realtime/runs and consume typed Server-Sent Events.

Agent management

Create agents, replace provided fields, or request natural-language edits before running them by agent_id.

​
Start here

1

Create an Account API key

Open Developer Console, go to API Keys, and create a server-side Account API key.
2

Create or copy an agent ID

Create a personal agent with POST /v1/agents, or open Agents in Developer Console and copy the agent_id for an existing active personal agent.
3

Create a run

curl -X POST https://developer.creao.ai/v1/runs \
  -H "Authorization: Bearer cr_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "00000000-0000-4000-8000-000000000000",
    "input": { "query": "Create a weekly sales summary" }
  }'
Account API keys are server-side secrets. Do not put them in browser frontend code or mobile apps.

​
API behavior

Authentication

Create keys, send bearer tokens, rotate secrets, and understand account-level scope.

Conversations

Reuse conversation_id values to continue context across async and realtime runs.

Webhooks

Receive terminal async run results at your backend.

Errors and rate limits

Handle stable error codes, retry headers, and credit-related failures.

API Paths

Compare app-scoped API Trigger keys with Developer Platform Account API keys.