intelligent-search

qa

Ask a question about a workspace, as one turn of a conversation. Cost class: job.

Every turn runs the automatic search agent on its own — no router, no fixed pipeline, no opening search. The agent finds what the turn needs itself, in the light of the conversation so far: it asks a navigator over the workspace's files, sections and pages, or, on a workspace in a bring-your-own bucket or customer storage, searches it. It then reads documents, queries tables, and selects documents from the metadata catalog until it can answer. Every tool enforces the caller's access and the conversation's scope: path_prefix and paths resolve to one file set.

Pass a result's session_id to ask a follow-up: the agent resumes the conversation, so "and for 2023?" or "why?" means what it means in context. When a question is genuinely ambiguous the agent may ask back instead (allow_clarification, on by default): the result then carries clarification_questions with answer null; reply with clarification_answers and the same session_id, or rephrase.

A conversation's first question that asks for nothing (a keyboard mash, say) and none of whose words a document contains is answered so without running the agent or a charge, and starts no conversation.

The result is the agent's answer — citations, SQL receipts, confidence — plus, when it answered from a catalog query, the catalog table, whose next_cursor continues through filtered-search.

post/v1/workspaces/{workspace_id}/qa

Request

Path parameters

workspace_idstring uuid required

Workspace identifier.

Query parameters

wait_secondsinteger

Bounded inline wait. 0 (the default) returns 202 immediately. Above 0 the route returns 200 with a terminal job if the work finished in time, and 202 with the still-running job if it did not. Either way, read status.

Headers

Idempotency-Keystring nullable

Replaying a request with the same key returns the original job with 200, never a second job. The key is kept with the job for replay and never cleared, so it must not contain personal data.

Request body

querystring required

What to answer, in the caller's own words. Stripped before its length is checked; a blank query is refused rather than run.

contextstring nullable

Free-form background for the model — the engagement, the entity, what the caller already knows. It informs the answer; it does not widen or narrow which files the caller may see.

path_prefixstring nullable

Put every uploaded file under one folder subtree, workspace-relative, in the run's scope; paths, where the body takes it, adds more files. Omit both for the whole workspace.

pathsstring[] nullable

Scope the conversation to exactly these uploaded files. Every tool the agent runs sees only these files and the content ingested from them. Each entry names an uploaded source file (never a folder — scope folders with path_prefix; the two add up). Unknown or inaccessible paths are refused up front.

session_idstring uuid nullable

Continue a conversation: the session_id echoed on an earlier turn's result. With the same folder/file scope and access grants the agent resumes the conversation, so a follow-up can lean on what was already asked and answered; a changed scope or grants starts a fresh conversation and returns a new session_id. Omit to start one. Only the API key that started it may continue it; a conversation whose turn is still running returns 409 session_busy.

allow_clarificationboolean

Let the agent ask instead of guessing when a question is genuinely ambiguous and the reading materially changes the answer. Such a turn's result carries the questions in clarification_questions with answer null; reply in the same conversation with clarification_answers or a rephrased query. A turn that sends clarification_answers never asks again. On by default; off means the agent always answers with its best reading, stated in the answer.

output_schemaobject nullable

A JSON Schema (Draft 2020-12, object root, local non-recursive $ref only, no pattern, patternProperties or unevaluated*) the answer must follow. When set, the agent writes answer as JSON text conforming to it, the run checks that and asks the agent to correct a mismatch, and the result carries the parsed value in structured_answer. A field the source does not state comes back null, whatever type the schema gives it. Explanation goes to reasoning where the result has one, and evidences are unchanged. If the answer still misses the schema, the run succeeds with answer as written and structured_answer null. Omit for a prose answer. Applies only to the turn that sends it: to keep structured answers across a conversation, send it on every turn, including a reply to clarifying questions. A turn that asks clarifying questions returns them with structured_answer null.

Response

Successful Response

job_idstring uuid required

Server-minted id. Poll GET /v1/jobs/{job_id} or pass wait_seconds on create.

kind'automatic_agent'

The automatic search agent, which answers every QA turn.

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

cancelled is a first-class terminal status, not a failed variant.

Conflating them makes error-rate metrics lie and forces every client to string-match an error code.

namestring nullable

Display name (the console's 'project'). Public Parse, Split, Classify, Extract, and Ground runs supply a stable server default when blank; citation-generated Ground jobs are excluded. mutable via PATCH /v1/jobs/{job_id}.

project_idstring uuid nullable

Caller-minted grouping id shared by jobs submitted together. Filterable on GET /v1/jobs.

workspace_idstring uuid nullable

The workspace this job reads. Null for a document operation whose source is an upload, a URL, or a prior parse result.

idempotency_keystring nullable

Key that was replayed to return this job. Absent when the create call had no Idempotency-Key.

forceboolean nullable

The request's own force flag, echoed regardless of outcome. Present for kinds whose request carries one (e.g. kg_build, where a true value cleared the durable store before the job ran) so a caller can tell that apart from a build that failed leaving the prior store untouched — result alone cannot, since it is absent on failure either way.

querystring nullable

The question this job was asked, for the search kinds that carry one (intelligent_search, qa_file, qa_tables, filtered_search); null for every other kind. Read from the stored request, so it rides the same retention path as result: null once result_state leaves available. Narrow by design — the frozen access context never reaches the wire. File scope is summarised separately as query_scope.

effortstring nullable

How hard this run worked, for the search kinds that carry it. A deep-search job (kind deep_search_v2) created before the effort knob was removed echoes its requested level: 'low', 'medium', or 'high'; newer deep-search jobs, which all run one configuration, read null. An intelligent_search row carries an internal selector instead: 'fast' is fact-search, 'automatic' is automatic-search, and 'deep' (or the legacy 'balanced') is a deep-search or console QA chat job created before the 2026-09 consolidation — those two are not distinguishable by this field. Null for every other kind. Read from the stored request, so it rides the same retention path as query and result: null once result_state leaves available.

surface'deep_search' | 'qa' | 'workbook' nullable

Which console history this deep-search job belongs to. deep_search is the public route and the Deep Search page; qa and workbook are the console chat skins over the same agent. It does not pick the implementation. Null for fact-search and every non-deep-search kind. Jobs stored before this field existed echo deep_search. Read from the stored payload, so it rides the same retention path as query.

result_state'available' | 'expired' | 'not_retained' | 'cancelled' | 'storage_unavailable'

Why Job.result is null.

available with a null result means the job has not succeeded yet; expired means its content was removed; not_retained means the client is provisioned zero_retention and already had its one chance to read it; cancelled means the job, or the root job it ran for, was cancelled. A cancelled job serves no results (it is not charged, including delivered parts) — not its own progressive values, and not a delegated child's result. It is a read state only, derived on the wire; no row stores it. storage_unavailable withholds a retained result while its workspace binding refuses access; Job.result_error explains the current refusal. A late poll returns the job with a state, never a 404 — "this expired" and "this never existed" are a scheduling problem and a bug respectively, and a 404 makes them identical.

unitsinteger

Measured work in legacy credit units, retained even when a failed or cancelled job is not billed. Kept for compatibility: credits is the authoritative billed amount.

creditsinteger nullable

Final credits billed for this job, priced once under credit_schedule_version. Null until usage_final is true. Never changes afterwards, including after payload expiry or deletion. Failed and cancelled-before-completion jobs finalize with 0 credits, including delivered parts; ones finalized before that policy keep their credits. Always null on a stage job that Automatic Search delegated: its work is billed on the parent job.

usage_finalboolean

True once credits is final and will not change. False while the job is queued or running, and until any cleanup of its delegated stages has been accounted for. A failed tool job (read_file, run_sql, hybrid_search, grep, file_metadata, folder_metadata) created with an Idempotency-Key stays false for one hour after it fails, because a retry with the same key re-runs it; after that hour it is final and the retry returns the stored error.

credit_schedule_versioninteger nullable

Version of the credit schedule credits were priced under. Null until usage_final is true.

usage_finalized_atstring date-time nullable

When credits became final. Null until usage_final is true.

created_atstring date-time required

When the job row was created.

started_atstring date-time nullable

When execution began. Null while still queued.

finished_atstring date-time nullable

When the job reached a terminal status.

payload_expires_atstring date-time nullable

Cleanup deadline after explicit deletion. Null for retained content; Zero retention uses its delivery window.

deleted_atstring date-time nullable

When the caller hid this run from listings, via delete_job. A soft delete: the job still reads by id and still counts toward GET /v1/usage — what it stops doing is appearing in GET /v1/jobs.

Changes

No recorded changes to this operation across all 1 revision of this API.