REST API
Manage guidance, read analytics and run your workspace from your own code.
The REST API is what the dashboard, the CLI and AI agents use. Anything your role allows in the dashboard, a key can do over the API, with the same validation, plan limits, approval rules and audit log.
Basics
| Base URL | https://app.cueston.com/api |
| Authentication | Authorization: Bearer sk_…. See Authentication. |
| Format | JSON request and response bodies (Content-Type: application/json), camelCase field names |
| Dates | ISO 8601 strings in UTC, like 2026-10-26T09:30:00.000Z |
| Errors | { "error", "code", "details"? } with an HTTP status. See Errors. |
curl https://app.cueston.com/api/tours \
-H "Authorization: Bearer $CUESTON_API_KEY"{
"tours": [
{
"id": 318,
"name": "Invoice flow",
"urlPattern": "https://app.example.com/invoices*",
"isActive": true,
"stepCount": 5,
"publication": {
"production": { "versionId": 1290, "version": 7, "publishedAt": "2026-10-20T14:02:11.000Z" },
"staging": null
},
"hasUnpublishedChanges": false,
"createdAt": "2026-09-02T10:11:00.000Z",
"updatedAt": "2026-10-20T14:02:11.000Z"
}
]
}Responses name what they contain: a list comes back as { "tours": [...] }, one item as { "tour": {...} }.
Content endpoints
Tours, tooltips, banners, checklists, surveys and announcements share the same endpoints under their plural name (/tours, /tooltips, /banners, /checklists, /surveys, /announcements):
| Endpoint | What it does |
|---|---|
GET /{type} | List items with their publish status |
POST /{type} | Create a draft |
GET /{type}/{id} | The working draft, with its publish status |
PATCH /{type}/{id} | Change the working draft (fields you leave out stay as they are) |
DELETE /{type}/{id} | Delete the item, with its versions and translations |
POST /{type}/{id}/duplicate | Copy it as a new draft named "Copy of …" |
POST /{type}/{id}/publish | Publish the draft as a new version to production or staging |
POST /{type}/{id}/unpublish | Stop showing it in an environment |
POST /{type}/{id}/publish-requests | Ask a publisher to review and publish it |
GET /{type}/{id}/versions | Version history |
POST /{type}/{id}/versions/{versionId}/publish | Publish an earlier version (roll back) |
POST /{type}/{id}/versions/{versionId}/restore | Copy an earlier version into the draft |
Saving never changes what your users see. Only publishing does, and publishing to production follows your workspace's approval rules.
The reference lists every endpoint with its fields, plus segments, analytics, survey responses, translations, review requests, webhooks, end-user data and the audit log.
Reference
The reference pages in the sidebar are generated from Cueston's OpenAPI document. Each shows the permission it needs, the request and response schemas, and examples in curl, JavaScript and Python.