API do Decoding Chat

O Decoding Chat é uma plataforma de chat auto-hospedável.

• Para criar um cliente ou um bot, comece pela API HTTP e pelo Gateway.
• Para voz e compartilhamento de tela, leia Voz.
• Para rodar uma instância, comece por Primeiros passos.

Superfícies do protocolo

Use a API HTTP para ler e alterar recursos, e os eventos do Gateway para receber atualizações. O Proxy de mídia serve mídia e uploads. A API de administração oferece gerenciamento privilegiado da instância.

Contratos compartilhados

Consulte Autenticação, Erros, Limites de taxa e Idiomas para o comportamento compartilhado. A maioria dos identificadores de recurso são snowflakes. Cada página de recurso indica onde ela difere desse comportamento compartilhado.

Notação de campos

Nas tabelas de campos, ? depois do nome do campo significa opcional. Antes do tipo, significa que aceita null.

Campo	Tipo	Significado
name	string	Obrigatório e não pode ser null
name?	string	Opcional, mas não pode ser null quando presente
name	?string	Obrigatório, mas pode ser null
name?	?string	Opcional e anulável, então pode ser omitido ou definido como null

Um campo omitido é diferente de um campo definido como null. Cada operação explica como esses valores afetam o recurso.

Na coluna de tipo, array[tipo] é um array do tipo indicado, e map[chave, valor] é um objeto JSON com chaves do primeiro tipo e valores do segundo.

Descoberta de endpoints

Comece com GET /.well-known/fluxer na origem da instância. Não exige autenticação e permite requisições entre origens.

GET https://example.com/.well-known/fluxer

Leia as URLs base a partir dos endpoints da resposta. Não as derive da origem nem escreva domínios fixos no código.

• Bots, bibliotecas e clientes de terceiros usam endpoints.api_public.
• A aplicação web oficial usa endpoints.api_client. endpoints.api é um apelido para ele.

Use caminhos /v1 e envie as credenciais no cabeçalho Authorization, conforme descrito em Autenticação.