Stac

Referência da API

Referência da API

URL base, convenções de requisição e os endpoints que o Stac expõe.

A API é HTTP + JSON sobre TLS (multipart nos endpoints que aceitam upload de arquivo). Todos os endpoints ficam sob uma única URL base e recebem o mesmo bearer token.

POSThttps://api.trystac.com/v1

Convenções

  • Content type. application/json, exceto /v1/documents/extract, /v1/images/extract, /v1/images/edits e a entrada do modo direto de /v1/documents/generate, que são multipart/form-data.
  • O campo model escolhe o modelo. Envie um dos valores listados em Modelos; um modelo que o plano da sua chave não inclui devolve 403.
  • Campos desconhecidos. São ignorados na entrada, então um SDK mais novo continua compatível com uma versão mais antiga da API.
  • Erros. Um status fora da faixa 2xx com um corpo { "detail": "..." } — veja Erros. As rotas de imagem também devolvem um segundo formato, com um code legível por máquina.

Endpoints

EndpointDescrição
POST/chat/completionsChat compatível com a OpenAI, incluindo entrada de imagem e tool calling
POST/messagesChat compatível com a Anthropic, sobre o mesmo modelo
GET/modelsOs modelos que a sua chave pode usar
POST/documents/extract, /images/extractEntra um PDF ou uma imagem, sai um JSON validado pelo schema
POST/images/generations, /images/editsEntra um prompt, sai uma imagem — ou edite imagens existentes a partir de referências
POST/documents/generateEntra HTML (o seu, ou gerado pelo modelo a partir de uma instrução), sai PDF

Versionamento

O prefixo /v1 é o contrato. Mudanças aditivas — campos novos, endpoints novos, valores novos de enum — saem sem troca de versão, então os clientes precisam tolerar campos que não reconhecem. Mudanças incompatíveis ganham um prefixo novo e uma janela de migração anunciada no changelog.