List page cues

Every page this agent can open a conversation about, most-shown first, with each cue's own shown / opened / asked record.

gethttps://api.integrable.cloud/api/agents/{agent_id}/cues

Authentication: Bearer token
Retries: Safe to repeat
Body: None
Version: 2026-09-03

Path parameters#

agent_idstringrequired

Query parameters#

limitinteger
Default: 50·≥ 1 and ≤ 100
offsetinteger
Default: 0·≥ 0

Responses#

200OKapplication/json
PageCuesList
- itemsarray of PageCuesReadrequired
  12 fieldsPageCuesRead
  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
- pendingintegerrequired
- totalintegerrequired
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.

Request · curl

curl "https://api.integrable.cloud/api/agents/$AGENT_ID/cues" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY"

Set INTEGRABLE_API_KEY and the path variables first. The TypeScript and Python SDKs take the same fields.

Response · 200 OK · application/json

{
  "items": [
    {
      "cues": [
        {}
      ],
      "disabled": false,
      "generated_at": "2026-09-03T09:30:00Z",
      "id": "01a0652b-3713-7ea1-a6c9-2e895389ec34",
      "language": "string",
      "mined_at": "2026-09-03T09:30:00Z",
      "opener": "string",
      "owner_edited_at": "2026-09-03T09:30:00Z",
      "page_type": "string",
      "title": "string",
      "updated_at": "2026-09-03T09:30:00Z",
      "url": "https://example.com"
    }
  ],
  "pending": 0,
  "total": 0
}

Generated from the schema: the shape is exact, the values are placeholders.

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.
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.