Ask
POST /v1/workspaces/{workspace_id}/query
POST
/v1/workspaces/{workspace_id}/query
Ask a question grounded in the workspace; returns the agent’s answer with file citations.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” workspace_id
required
Workspace Id
integer
Request Body required
Section titled “Request Body required ” QueryRequest
object
question
required
Question
Natural-language question about the workspace.
string
Responses
Section titled “ Responses ”Successful Response
QueryResponse
object
answer
required
Answer
Agent answer. May contain <<file_id = N>> citation tags.
string
citations
Citations
File ids referenced by citation tags in the answer.
Array<integer>
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context