Cursor pages
Used by conversations, messages and widget threads.limit to size the page, and pass the previous response’s next_cursor as cursor to get the next page. Keep going while has_more is true; do not infer the end from a short page.
Offset pages
Used by documents.offset by limit for each page while has_more is true.
Unpaged lists
Assistants, knowledge sources, ingestion jobs, collections, API keys and widget deployments return their items without a cursor, in adata array. Widget deployments use a deployments array instead. Assistants, ingestion jobs, API keys and widget deployments accept limit; knowledge sources and collections always return every item. See each endpoint.
Limits
An over-largelimit is handled one of two ways, depending on the endpoint:
- Refused with
400: conversations, messages, assistants, API keys and widget deployments. - Reduced to the maximum of 100: ingestion jobs and documents.
limit that is not plain ASCII digits, or is more than nine digits long, also returns 400, and so does a cursor this server did not issue.
Each endpoint’s page gives its default and maximum.