Single-shot Q&A over project knowledge | Pyramid AI

curl -X POST https://api.pyramid-ai.com/api/v2/agent/query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "query": "What are the main compliance requirements?"
}'

{
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "success": true,
  "data": {
    "answer": "The main compliance requirements include data privacy regulations such as GDPR and CCPA, industry-specific standards like HIPAA for healthcare, and internal company policies on data handling and user-",
    "sources": [
      {
        "id": "doc-7890",
        "title": "Compliance Overview Document",
        "relevance": 0.95
      }
    ],
    "model": "pyramid-agent-v2.1",
    "usage": {}
  },
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

Stateless query endpoint — does not persist a chat history. Use this for one-off questions. For multi-turn conversation, use POST /chat instead.

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.

project_idstringRequiredformat: "uuid"

querystringRequired<=100000 characters

max_sourcesintegerOptional1-20Defaults to 5

response_formatenumOptionalDefaults to text

Allowed values:

response_schemaobjectOptional

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

search_scopeenumOptionalDefaults to project

Allowed values:

Response

Query result

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