Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.chief.bot/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Several Chief API list endpoints use cursor-based pagination so you can walk large datasets without offset drift. Paginated responses include:
FieldDescription
dataItems in this page.
first_idId of the first item in this page (omitted when empty).
last_idId of the last item in this page (omitted when empty).
has_moretrue when another page exists after this one.
Use resource ids as cursors. The cursor id is excluded from the next page (the page starts strictly after or before that id).

Supported endpoints

EndpointPagination
GET /v1/chatsCursor (after_id, before_id, limit)
GET /v1/assetsCursor (after_id, before_id, limit)
GET /v1/labelsReturns full list in v1 (has_more is always false)

Parameters

All cursor-paginated endpoints accept:
limit
integer
default:"25"
Maximum items per page. Minimum 1, maximum 100.
after_id
string
Resource id from the previous response’s last_id. Returns items strictly after this id. Omit on the first request. Mutually exclusive with before_id.
before_id
string
Resource id to paginate backward from. Returns items strictly before this id. Mutually exclusive with after_id.

Response format

{
  "data": [
    { "chat_id": "chat_d8aad64dib2c7m3ae7j0", "created_at": "2026-05-23T10:15:30Z" },
    { "chat_id": "chat_d8aad64dib2c7m3ae7j1", "created_at": "2026-05-23T10:16:00Z" }
  ],
  "first_id": "chat_d8aad64dib2c7m3ae7j0",
  "last_id": "chat_d8aad64dib2c7m3ae7j1",
  "has_more": true
}
Chats are returned newest first. Assets follow the same list envelope.

Forward pagination

Pass last_id from the current page as after_id on the next request when has_more is true:
# First page
curl -sS "$CHIEF_BASE_URL/v1/chats?limit=25" \
  -H "X-API-Key: $CHIEF_API_KEY" \
  -H "X-Project-Id: $CHIEF_PROJECT_ID"

# Next page
curl -sS "$CHIEF_BASE_URL/v1/chats?limit=25&after_id=chat_d8aad64dib2c7m3ae7j1" \
  -H "X-API-Key: $CHIEF_API_KEY" \
  -H "X-Project-Id: $CHIEF_PROJECT_ID"

Backward pagination

Pass first_id from the current page as before_id to walk toward older items:
curl -sS "$CHIEF_BASE_URL/v1/chats?limit=25&before_id=chat_d8aad64dib2c7m3ae7j0" \
  -H "X-API-Key: $CHIEF_API_KEY" \
  -H "X-Project-Id: $CHIEF_PROJECT_ID"

Best practices

  • Check has_more before requesting another page.
  • Choose a limit that fits your use case (smaller for UI lists, larger for batch exports).
  • Do not send after_id and before_id in the same request.
  • Introduction
  • Errors
  • API reference → ChatsGET /v1/chats
  • API reference → AssetsGET /v1/assets