API ExplorerAgent

Create an Agent batch query

Submit multiple questions for batch processing over project knowledge or the Open Library. search_scope: open_library requires the api.open_library feature and takes no project_id.

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
namestringRequired1-200 characters
questionslist of objectsRequired
project_idstringOptionalformat: "uuid"

Required when search_scope is “project” (the default); must be omitted for “open_library”.

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)

search_scopeenumOptionalDefaults to project
Which corpus the questions are answered from. No "org" scope for batches.
Allowed values:

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
dataobjectOptional
paginationobjectOptional

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

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error