Skip to content

Get OpenAPI specification

GET
/openapi.yaml

Returns the OpenAPI schema definition for this API, allowing clients to understand the available endpoints and models.

OpenAPI schema definition

object

Error occurred

Error information returned by the API.

object
error

Error details.

object
message
required

Human-readable error message.

string
Example
File not found
data

Additional data related to the error, if any.

object
key
additional properties
any