Reference

Meta

Meta: 1 operation (meta.openapi).

Method	Path	Operation
`GET`	`/v1/openapi.json`	meta.openapi

meta.openapi

GET/v1/openapi.json

The OpenAPI 3.1 document of this API.

Public: no API key needed. Without a key this is the public document, generated from the operation contracts on every deploy and cached for five minutes. A request that presents an API key gets that key's view instead: the operations, fields and errors that key may use, never cached. A key that does not authenticate is refused, not served the public document.

Operation id	`meta.openapi`
Scopes	None: public, no API key
Idempotency	Not applicable

Response 200

JSON of type object.

Errors

Status	Code	When
401	`API_KEY_INVALID_401`	With an API key: the key presented is invalid, revoked or expired. A broken key is refused, never served the public document.
403	`API_KEY_SURFACE_403`	With an API key: the key was created for the integrations endpoints only.
403	`API_ORG_DISABLED_403`	With an API key: API access is disabled for the key's organization.
429	`API_RATE_LIMITED_429`	With an API key: the key's or organization's rate limit is reached. Retry after the number of seconds in Retry-After.
503	`API_DISABLED_503`	With an API key: the developer API is temporarily disabled. Retry later.

A public operation answers only the request level errors: see Errors.

Example

bash

curl "https://api.dmhero.ai/v1/openapi.json"

JSON Schema

Response 200

{
  "type": "object",
  "propertyNames": {
    "type": "string"
  },
  "additionalProperties": {}
}