Lingara Lingara Docs Guides API Libraries Apps Build Web app
Language: English

Get the events document

API version 2026-10-affable-towhee

get https://api.getlingara.com/v1/asyncapi.json

Returns the AsyncAPI document that describes Lingara's events, for the API version the request is answered under: the one named in Lingara-Version, or else the current version. No token is needed.

Scopes No authentication required

Parameters

Lingara-Versionheaderstringoptional
The API version to answer this request under. Without it, an access token gets the version its client is pinned to, and a request with no token gets the current version. The version still in development is reached only by naming it here. An unknown version answers 400 with code api_version_unknown. GET /v1/versions lists the versions.

Responses

200 The AsyncAPI document

Errors

410application/json
The API version this request is answered under has been discontinued. Send a supported version in Lingara-Version, or re-pin the client.
4XXapplication/json
The request was refused. code says why, and error says it in words.
503application/json · text/plain
The service is temporarily unavailable; retry after the number of seconds in Retry-After. During maintenance the body is plain text rather than the error envelope.
codestringrequired

Why the request was refused, as a stable code to branch on: for example insufficient_scope (403), rate_limited (429) and, for a metered client, spend_cap_reached (402) and metered_billing_inactive (402).

errorstringrequired

Example

curl "https://api.getlingara.com/v1/asyncapi.json"

Prefer a library? See the Libraries section.