DocsAPI reference

Update page cues

Edit a page's opener and questions, hide one, or switch the page off.

put/api/agents/{agent_id}/cues/{page_id}
Authentication
Bearer token
Retries
Idempotency-Key
Body
application/json
Version
2026-09-03

An edited or added question becomes the owner's and is never overwritten by generation or mining; a hidden one stays hidden when a later run writes the same sentence again.

Path parameters#

  • agent_idstringrequired
  • page_idstringrequired

Headers#

  • Idempotency-Keystring

    A unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with Idempotent-Replay: true set.

    Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.

    Up to 255 characters

Request body#

application/json · required

PageCuesUpdate

  • cuesarray of CueEdit

    Up to 8 items

    3 fieldsCueEdit
    • textstringrequired

      1–72 characters

    • hiddenboolean

      Default: false

    • idstring | null

      Up to 16 characters

  • disabledboolean | null
  • openerstring | null

    Up to 110 characters

Responses#

  • 200OKapplication/json

    PageCuesRead

    • idstringrequired
    • page_typestringrequired
    • urlstringrequired
    • cuesarray of CueRead
      8 fieldsCueRead
      • idstringrequired
      • sourcestringrequired

        One of: owner, mined, generated

      • textstringrequired
      • askedinteger

        Default: 0

      • hiddenboolean

        Default: false

      • open_ratenumber | null
      • openedinteger

        Default: 0

      • showninteger

        Default: 0

    • disabledboolean

      Default: false

    • generated_atstring | null
    • languagestring | null
    • mined_atstring | null
    • openerstring | null
    • owner_edited_atstring | null
    • titlestring | null
    • updated_atstring | null
    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • idempotency_key_reused · 422 — This `Idempotency-Key` was used before, for a request with a different body.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Page cues endpoints#

Something unclear or missing? Tell us and we’ll fix it.