API overview

https://api.resolido.com/v1

The API covers everything the dashboard can do, except billing and signing in. It is described by an OpenAPI 3.1 spec, which also powers the CLI, the TypeScript SDK, the MCP server and the reference in these docs.

First requestCopy link to this section

Create an API key in Settings → Developers, then:

curl https://api.resolido.com/v1/me \
  -H "Authorization: Bearer rsl_live_…"

{
  "user": { "id": "k17…", "email": "[email protected]", "name": "Jana" },
  "organization": { "id": "tn7…", "name": "My shop", "slug": "my-shop", "timeZone": "Europe/Prague" },
  "role": "owner",
  "token": {
    "id": "j57…",
    "kind": "api_key",
    "name": "Order sync",
    "scopes": ["conversations:read", "conversations:reply", "…"],
    "expiresAt": null
  }
}

ConventionsCopy link to this section

• JSON in, JSON out. Send Content-Type: application/json. Timestamps are Unix milliseconds.
• The key acts as you. Every call runs as the user who created the key, inside one organization. Permissions are your role intersected with the key's scopes – a key never exceeds its author's role.
• Ids are opaque strings. Conversations use prefixed ids, chat_… (chat widget, WhatsApp, Instagram) and email_…, in one unified inbox.
• Errors follow RFC 9457 problem details with a machine-readable code and a hint.
• Lists use cursor pagination.
• Customer-facing writes require an Idempotency-Key; destructive operations need a confirmation.
• Every response has an X-Request-Id – include it when you contact support.

Risk levelsCopy link to this section

Each operation in the reference is labeled with x-risk:

ReferenceCopy link to this section

The reference is generated from the API itself, grouped by area: Account, Organization, AI agents, Chat widget, Knowledge, Skills, Channels, Conversations, Contacts, Automation, Insights and Statistics. Use the sidebar or search.