Skip to main content
POST
curl

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for stock_reference.

catalog
enum<string>
required

Catalog to return.

Available options:
refusal_tokens,
refusal_reasons,
operating_rules,
concepts,
units,
shapes,
filing_forms,
8k_items,
capabilities,
form4_codes,
fields,
coverage
q
string | null

Optional text filter for catalogs that support search.

Required string length: 1 - 128
rule_id
string | null

Optional operating-rule filter.

Required string length: 1 - 128
schema
enum<integer>
default:2

Response schema selector. Omit (or send 2) for the schema-2 envelope, the default; 1 selects the frozen legacy wire. Boolean values are rejected by the API boundary.

Available options:
1,
2

Response

Read self-describing reference catalogs. Envelope-level schema; captured examples remain authoritative for full nested payload detail.

Schema-2 envelope. The OpenAPI schema is structural; captured examples are authoritative for full nested payload detail.

data
object
required

Tool payload or typed schema-2 refusal.

meta
object
required

Schema-2 metadata. Unknown optional fields are omitted, not emitted as null.

subject
object

Resolved entity and security when the tool has a single subject.