Documentação da API

A API da Yris é compatível com o padrão OpenAI. Se o seu time já usa um cliente de IA, é só apontar a base_url para a Yris e seguir o trabalho — em português.

Comece em poucas linhas

Base URL e autenticação

Todas as chamadas vão para https://yrisia.com.br/v1 e usam uma chave no header Authorization: Bearer SUA_CHAVE_YRIS (sua chave começa com yris-sk-). Gere sua chave em Chaves de API (basta entrar com sua conta Google) — ou, para planos empresariais, fale com nosso time pelo formulário para empresas.

Python (biblioteca OpenAI)

from openai import OpenAI

client = OpenAI(
    api_key="SUA_CHAVE_YRIS",
    base_url="https://yrisia.com.br/v1",
)

resposta = client.chat.completions.create(
    model="yris-1",
    messages=[
        {"role": "user",
         "content": "Resuma este contrato em 3 tópicos."}
    ],
)

print(resposta.choices[0].message.content)

cURL

curl https://yrisia.com.br/v1/chat/completions \
  -H "Authorization: Bearer SUA_CHAVE_YRIS" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "yris-1",
    "messages": [{"role": "user", "content": "Olá, Yris!"}]
  }'

Endpoints

Parâmetros de /v1/chat/completions

Limites e erros

Os limites valem para POST /v1/chat/completions e contam numa janela deslizante de 60 segundos:

• 60 requisições por minuto por chave (a contagem segue o valor enviado em Authorization: Bearer).
• 120 requisições por minuto por endereço IP, somando todas as chaves que saem dele.
• 300 requisições POST por minuto por endereço IP no site inteiro (teto contra abuso).

Códigos de erro

Exemplo de resposta 429:

HTTP/1.1 429 Too Many Requests
Retry-After: 12
Content-Type: application/json

{
  "detail": "Você passou de 60 mensagens por minuto neste endereço. Aguarde cerca de 12 s e tente de novo.",
  "retry_after": 12
}

Retry-After e retry_after trazem o mesmo número: os segundos que faltam para a requisição mais antiga sair da janela (no mínimo 1). No teto de 120 por IP o texto cita 120; no teto global de POST o detail muda para “Muitas requisições em pouco tempo a partir deste endereço. Aguarde cerca de 12 s e tente de novo.” Programe a espera pelo header, não pelo texto.