Skip to main content
GET
Get the API index

Response

200 - application/json

API index

The public index of the API, served without a credential at /api/v1.

name
string
required

Human-readable API name.

version
string
required

Current major version, matching the URL path segment.

base_url
string<uri>
required

Absolute base URL every operation hangs off.

documentation_url
string<uri>
required
openapi_url
string<uri>
required

This specification.

authentication
object
required
rate_limits
object
required
versioning
object
required
resources
object
required

Absolute URL per top-level resource, path templates included.

description
string

What the API does.

developers_url
string<uri>
llms_txt_url
string<uri>
clients
object
webhooks_documentation_url
string<uri>