Skip to main content
POST
Get ArtifactQuery schema

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token. Example: "Authorization: Bearer {apiKey}"

Body

output_format
null | enum<string>

Optional success projection. Omit to return both obj and rendered; use json for obj only; use agentic for rendered text only. Repairable errors always return both obj.error and rendered.

Available options:
json,
agentic
entity
null | string

Optional ArtifactQuery entity to describe, such as files or symbols. Omit for the full schema.

include_examples
null | boolean

Include example ArtifactQuery statements. Default is true.

Response

Success envelope. obj is the ArtifactQuery catalog: dsl_version, entities, fields, relationships, operators, required_limit, and examples; rendered is the JSON-serialized form of obj. Repairable failures (missing or invalid arguments, ambiguous or unknown data sources) also return HTTP 200 with obj.error = { code, message, retry, try } and a rendered <tool_error> block; repair the arguments and retry.

obj
any

Arbitrary JSON result for the tool. Present for omitted/json success projections and every repairable error.

rendered
null | string

Agent-facing result text. Present for omitted/agentic success projections and every repairable error.