Search Schema

Retrieve the versioned filter and field schema accepted by World Search.

GET/api/v2.0-preview/search/schema

Authorizations

Bearer
Authorizationstringrequiredheader

Required Bearer API key. Programmatic access to the World API needs a key; browsing nosible.world in a browser does not.

Example: Bearer nos_sk_...

How to use this endpoint

guidance

Fetch this schema before generating dynamic World Search filters. It is the machine-readable inventory of supported fields, operators, aliases, entity types, semantic controls, and ontology values. Cache it by revision and invalidate your cache when revision changes.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

schemastring

Response schema name.

revisioninteger

Revision of the catalogue; cache by it.

endpointstring

The search route the catalogue describes, as the backend names it.

search_typesstring[]

Supported retrieval modes.

semantic_inputsobject

How q, vector, vectors, vector_texts, score_vectors and score_vector_texts are used.

date_grouped_semanticobject

How to request date-grouped semantic search, with its limits.

operatorsobject

Filter operators per field type.

entity_typesstring[]

NER types of the entity_* filter fields.

resolve_endpointstring

The resolver route, as the backend names it.

logicalstring[]

Logical filter operators.

geoobject

Shapes of the bbox and geo_radius filters.

retrievalobject

Retrieval paths for archive, live and filtered semantic search.

semantic_filter_modesstring[]

Semantic filter strategies.

fieldsobject[]

Every filterable field.

fields[].namestring

Field name, as used in filters, sort and facets.

fields[].typestring

Field type: string, number, boolean, date or string_set; operators lists what each accepts.

fields[].aliasesstring[]

Other names accepted for the field.

fields[].facetboolean

Whether facets can count the field.

Responses and errors

HTTP
200Request succeeded. The response body is shown in the panel on the right.
400invalid_request — The date, filter, cursor, identifier, or request combination is invalid.
401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.
401invalid_api_key — The API key is invalid or has been revoked.
403access_denied — The requested archive date is outside the caller's World tier.
404not_found — The requested date, entity, ticker, or event does not exist in the accessible index.
410cursor_expired — The cursor was minted against a replaced index build. Restart pagination from the first page.
429rate_limited — The request exceeded the endpoint or account rate limit. Respect Retry-After when supplied.
501backend_not_configured — The World backend is not configured for this deployment.
503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.
502backend_error — The BFF could not obtain a valid response from the World backend.
504backend_timeout — The World backend or an upstream data source timed out.