REST API

A REST API for everything you do in the dashboard

The dashboard, the CLI and AI agents all use the same REST API. Anything your role allows in the dashboard, a key can do from your code.

List your tours
curl https://app.cueston.com/api/tours \
  -H "Authorization: Bearer $CUESTON_API_KEY"

Zaufało nam ponad 200 rosnących firm SaaS

  • FreshTricks
  • Geek Dynamic
  • Kiteframe
  • Morrowbit
  • Ochreline
  • Tandemly

What you get

  • One pattern for all content

    Tours, tooltips, banners, checklists, surveys and announcements share the same endpoints under their plural name.

  • Saving never goes live

    Saving changes the draft only. Publishing to production follows your workspace's approval rules.

  • Errors you can branch on

    Every error has an HTTP status, a stable code and, for validation, one line per problem in details.

How it works

From an idea to live guidance, without waiting on a release.

  1. Create a key

    Open Settings → API keys and create a secret key. The secret is shown once.

  2. Store it on your server

    Keep it in your server's environment or your CI's secret store, never in source code or a browser.

  3. Call the API

    Send it as Authorization: Bearer sk_… to https://app.cueston.com/api.

What's included

Content endpoints
Create, read, update, delete and duplicate drafts; publish to production or staging; unpublish; request review.
Versions
Read version history, publish an earlier version to roll back, or copy it into the draft.
Beyond content
Segments, analytics, survey responses, translations, review requests, webhooks, end-user data and the audit log.
Keys that act as a person
A key acts as the person who created it, with their current role. If they leave the workspace, the key stops working.
Generated reference
Reference pages come from Cueston's OpenAPI document, with the permission each endpoint needs and examples in curl, JavaScript and Python.

Questions

Most endpoints have no fixed limit. Expensive ones, like exports and machine translation, have their own. See [rate limits](/docs/api/rate-limits).

See it on your own product

Get a short walkthrough of Cueston on your app, or start free and build your first one today.