For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
      • GETExport batch results as CSV
      • GETGet a batch with results
      • GETList Agent batch queries
      • POSTCreate an Agent batch query
      • POSTSingle-shot Q&A over project knowledge
      • POSTChat with the Agent over project knowledge
Get API Key
LogoLogo
API ExplorerAgent

List Agent batch queries

GET
/api/v2/agent/batches
GET
/api/v2/agent/batches
$curl https://api-staging.pyramid-ai.com/api/v2/agent/batches \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "request_id": "9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
3 "success": true,
4 "data": [
5 {
6 "id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
7 "name": "Q2 Safety Compliance Checklist",
8 "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9 "org_id": "org_ais",
10 "question_count": 25,
11 "created_at": "2026-05-22T10:00:00Z",
12 "trigger_run_id": "a7d9f8e2-4c3b-11ec-81d3-0242ac130003"
13 }
14 ],
15 "pagination": {
16 "total": 127,
17 "offset": 0,
18 "limit": 50
19 }
20}
Was this page helpful?
Previous

Create an Agent batch query

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Query parameters

project_idstringOptionalformat: "uuid"
limitintegerOptional<=200Defaults to 50
offsetintegerOptionalDefaults to 0

Response

List of batches
request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany
datalist of objects
paginationobject

Offset-based pagination for list endpoints. Clients compute has_more from offset + data.length < total. Cursor pagination may be added per-endpoint later if deep-pagination performance becomes a concern.

Errors

400
Bad Request Error
401
Unauthorized Error