Create an Agent batch query | Pyramid AI

curl -X POST https://api-staging.pyramid-ai.com/api/v2/agent/batches \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Q4 Compliance Check",
  "questions": [
    {
      "query": "Has the company updated its data privacy policies to comply with the latest regulations?"
    }
  ]
}'

{
  "request_id": "req_123456789abcdef",
  "success": true,
  "data": {
    "id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
    "name": "Q2 Safety Compliance Checklist",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "org_ais",
    "question_count": 25,
    "created_at": "2026-05-22T10:00:00Z",
    "trigger_run_id": "run_9876543210"
  },
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

Submit multiple questions to be answered in the background. Use this for bulk questionnaires, regulatory checklists, or any scenario with many questions. Results are available via GET /agent/batches/{id} and exportable as CSV.

curl -X POST https://api-staging.pyramid-ai.com/api/v2/agent/batches \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Q4 Compliance Check",
  "questions": [
    {
      "query": "Has the company updated its data privacy policies to comply with the latest regulations?"
    }
  ]
}'

{
  "request_id": "req_123456789abcdef",
  "success": true,
  "data": {
    "id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
    "name": "Q2 Safety Compliance Checklist",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "org_ais",
    "question_count": 25,
    "created_at": "2026-05-22T10:00:00Z",
    "trigger_run_id": "run_9876543210"
  },
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.

project_idstringRequiredformat: "uuid"

namestringRequired1-200 characters

questionslist of objectsRequired

question_templatestringOptional<=500 characters

Template with {input} placeholder applied to each question

response_formatenumOptionalDefaults to text

Allowed values:

response_schemaobjectOptional

JSON schema for structured output (required when response_format=json)

Response

Batch created and processing triggered

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

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api-staging.pyramid-ai.com/api/v2/agent/batches \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>	"name": "Q4 Compliance Check",
>	"questions": [
>	{
>	"query": "Has the company updated its data privacy policies to comply with the latest regulations?"
>	}
>	]
>	}'

1	{
2	"request_id": "req_123456789abcdef",
3	"success": true,
4	"data": {
5	"id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
6	"name": "Q2 Safety Compliance Checklist",
7	"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
8	"org_id": "org_ais",
9	"question_count": 25,
10	"created_at": "2026-05-22T10:00:00Z",
11	"trigger_run_id": "run_9876543210"
12	},
13	"pagination": {
14	"total": 127,
15	"offset": 0,
16	"limit": 50
17	}
18	}