Obter o documento de eventos

Versão da API 2026-10-affable-towhee

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

Devolve o documento AsyncAPI que descreve os eventos do Lingara, para a versão da API com que o pedido é respondido: a indicada em Lingara-Version ou, caso contrário, a versão atual. Não é necessário token.

Âmbitos Não é necessária autenticação

Parâmetros

Lingara-Versionheaderstringopcional: A versão da API com que responder a este pedido. Sem ela, um token de acesso recebe a versão a que o seu cliente está associado, e um pedido sem token recebe a versão atual. A versão ainda em desenvolvimento só é alcançada indicando-a aqui. Uma versão desconhecida responde 400 com o código api_version_unknown. GET /v1/versions lista as versões.

Respostas

200 O documento AsyncAPI

Erros

410application/json: A versão da API com que este pedido é respondido foi descontinuada. Envie uma versão suportada em Lingara-Version, ou associe o cliente a outra versão.
4XXapplication/json: O pedido foi recusado. code indica o motivo e error descreve-o por palavras.
503application/json · text/plain: O serviço está temporariamente indisponível; tente novamente após o número de segundos indicado em Retry-After. Durante a manutenção, o corpo é texto simples em vez do envelope de erro.

codestringobrigatório: O motivo pelo qual o pedido foi recusado, como um código estável para ramificar a lógica: por exemplo insufficient_scope (403), rate_limited (429) e, para um cliente com faturação por utilização, spend_cap_reached (402) e metered_billing_inactive (402).
errorstringobrigatório

Exemplo

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

Prefere uma biblioteca? Veja a secção Bibliotecas.

Se uma tradução e a referência em inglês divergirem, prevalece a referência em inglês.