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

Get a batch with results

GET
/api/v2/agent/batches/:id
GET
/api/v2/agent/batches/:id
$curl https://api-staging.pyramid-ai.com/api/v2/agent/batches/id \
> -H "Authorization: Bearer <token>"
1{
2 "request_id": "string",
3 "success": null,
4 "data": {
5 "created_at": "2026-05-22T10:00:00Z",
6 "id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
7 "name": "Q2 Safety Compliance Checklist",
8 "org_id": "org_ais",
9 "project_id": "string",
10 "question_count": 25,
11 "questions": [
12 {
13 "id": "string",
14 "batch_id": "string",
15 "project_id": "string",
16 "query": "Does the project have a documented fire safety plan?",
17 "status": "completed",
18 "created_at": "2024-01-15T09:30:00Z",
19 "answer": "Yes, the project includes a comprehensive Fire Safety Management Plan (document ref FSP-2026-01) which covers emergency procedures, fire warden assignments, and evacuation routes for all floors.",
20 "confidence": 0.91,
21 "sources": null
22 }
23 ],
24 "trigger_run_id": "string"
25 },
26 "pagination": {
27 "total": 127,
28 "offset": 0,
29 "limit": 50
30 }
31}
Was this page helpful?
Previous

List Agent batch queries

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Response

Batch details with question results
request_idstringformat: "uuid"

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

successany
dataobject
paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

401
Unauthorized Error
404
Not Found Error