Create an Agent batch query | Pyramid AI

curl -X POST https://api.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": "What are the latest regulatory requirements for data privacy in Q4?"
    },
    {
      "query": "List all safety protocols updated in the last quarter."
    },
    {
      "query": "Provide a summary of compliance audit results for Q4."
    }
  ]
}'

{
  "request_id": "req_7f8e9d6c-1234-4abc-9def-56789abcdef0",
  "success": true,
  "data": {
    "id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
    "name": "Q4 Compliance Check",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "org_ais",
    "question_count": 3,
    "created_at": "2024-06-15T09:30:00Z",
    "trigger_run_id": "run_20240615_0930"
  },
  "pagination": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Submit multiple questions for batch processing over project knowledge

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