Skip to main content
GET
Retrieve OpenAPI docs for entity

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

tagOrId
string
required

The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected. Entity identifier - can be a tag or CID

Query Parameters

name
string

Name of the OpenAPI spec to return. If you have multiple OpenAPI specs configured for your entity as x-cortex-links, use this parameter to ensure the correct spec is returned. If this parameter is not specified, we will return the first OpenAPI spec found.

Response

Successfully found documentation

spec
string
required

Stringified JSON representation of the OpenAPI spec

Last modified on September 29, 2026