Skip to main content
GET
Get app API reference

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app.

Response

The app's API reference, as an OpenAPI 3.0.3 document.

An OpenAPI 3.0.3 document describing the app's own API.

openapi
string
required

OpenAPI version of the document.

Example:

"3.0.3"

info
Info · object
required

Title and description of the app's API. The title is the app's name followed by API.

Example:
servers
Servers · object[]
required

The app's API address, built from its slug.

Example:
paths
Paths · object
required

One entry per endpoint of the app's entities, backend functions, and agents.

Example:
components
Components · object
required

A schema for each entity, and the api_key header the app's API authenticates with.

Example: