v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB

Ava

Ask Ava

Send a question to Ava and receive a synchronous response. Set ephemeral to true to skip conversation persistence (recommended for programmatic consumers). When ephemeral is false (default), the response includes a conversationId that can be used with the delete endpoint.

post/ava/v1/askSync

Request body

questionstring required

The question to ask Ava.

conversationIdstring

Optional ID of an existing conversation to continue.

ephemeralboolean

When true, the conversation is not persisted. Recommended for programmatic consumers (Terraform, MCP, CI pipelines).

Response

OK - Ava response returned.

answerstring

The Ava response text. Present on success.

conversationIdstring

The conversation ID. Present only for non-ephemeral requests. Can be used with the delete conversation endpoint.

answerIdstring

The answer ID within the conversation. Present only for non-ephemeral requests. Required for the feedback endpoint.

errorstring

Present instead of answer when generation fails after the response has begun streaming (the HTTP status remains 200). A human-readable error message.