SUsuperit
search

Get Agent Query Route

Poll for agent query results.

get/api/search/{team_key}/agent/{key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

keystring required
team_keystring required

Response

Successful Response

keystring required
status'pending' | 'running' | 'completed' | 'unavailable' | 'failed' required

Lifecycle of one natural-language data question.

The route's create writes pending; the DBOS workflow moves the row to running and then to exactly one terminal state. Values are stored verbatim in search.agent_query.status, so this enum is the single source of truth for the repository, the workflow and the polled response — a state the poller cannot match is now a name that does not resolve.

unavailable is terminal and is NOT a failure: the agent understood the question and established that no readable relation answers it. Rendering it as failed would tell users to retry something that cannot succeed, and as completed with zero rows would tell them the answer is "none".

questionstring required
sqlstring nullable
dataobject[] nullable
explanationstring nullable
errorstring nullable
attemptsinteger
createdAtstring nullable
completedAtstring nullable

Changes

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