API introduction

Audryo’s HTTP API is the same contract the product UI and coding agents use. If a guide and the OpenAPI document disagree, OpenAPI wins.

These docs show curl and JavaScript (`fetch`) in tabs. Generate clients for other languages from GET /v1/openapi (also docs/openapi.yml in-repo).

Base URL

{origin}/v1

Local default: http://localhost:3100/v1. Set AUDRYO_API_BASE once and reuse it in every example.

Authentication

Authorization: Bearer sf_live_...

Create tokens in Settings → Agent access. Scopes:

Tokens are workspace-bound and never inherit another workspace. Prefer the narrowest scope that completes the job.

Discovery endpoints

Human-readable index: `/llms.txt`.

Resource guides

Project setup path

Treat setup context as authoritative for first-run progress:

Foundation → Data → Audience → Opportunity → Journey → Message → Sending → Launch

Do not infer readiness from “a Journey exists.” Read delivery context before activation.

Idempotency

Send Idempotency-Key on LLM proposals, test sends, enrollments, campaign send, and transactional send. Keys are cached per (project, operation, key) for 24 hours.

Details: Best practices.

Pagination

Most collections use a cursor envelope:

{
  "data": [],
  "page": { "nextCursor": "...", "hasMore": true, "total": 4213 }
}

Pass page[after]=<nextCursor> until hasMore is false. Some list endpoints use an X-Next-Cursor response header instead — follow the OpenAPI entry for that route. Cursors are opaque; don’t parse or invent them.

Errors

Stable envelope on every failure:

{
  "error": {
    "code": "validation_failed",
    "message": "Human-readable explanation",
    "requestId": "uuid",
    "details": {}
  }
}

Also echoed as X-Request-Id. Switch on code. Include requestId when you contact support or file an issue.

Common flows

Related

• API resource guides
• Agent API reference — full operating contract
• Best practices
• OpenAPI: docs/openapi.yml / GET /v1/openapi