Skip to main content
Client App BuilderVersion: v3

Answer every question of one form in a single write.

POST/ai-builder-api/projects/{projectId}/runs/{runId}/answers/batch

Records up to 12 answers in one run write and resumes the run once, so a multi-question form does not resume the planner per answer. Same per-answer rules as POST …/answers (records review approval by approve:<reviewId> only, decline:<reviewId> declines, anything else is a change request); attachmentIds are ignored here. Project-scoped (404 for another project's run); locationId comes from the session, never from the body.

Idempotency: an answer whose capId and correlationId match the recorded one is skipped; when every answer is such a duplicate nothing is written and the run is not resumed again (still 202).

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:clientportal-ai.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

The API version.

Available optionsv3
Example:v3

Path Parameters

projectIdstringrequired

The project's id.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

Example:prj_5f0c2a3e
runIdstringrequired

The run's id.

Possible values: Value must match regular expression ^run_[A-Za-z0-9_-]+$

Example:run_8f3c2a91

Body

answersobject[]required

Each item is validated as AnswerQuestionRequest; attachmentIds are ignored on this route.

Possible values: >= 1, <= 12

Response

Answers recorded; any awaiting agent resumes asynchronously.

okbooleanrequired

The answers were accepted.

Available optionstrue
Example:true