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. Gere sua chave em Chaves de API (basta estar logado) — ou, para planos empresariais, fale com empresas@yrisia.com.br.

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

Método	Rota	Descrição
POST	/v1/chat/completions	Gera uma resposta a partir de uma lista de `messages` (formato OpenAI).
GET	/v1/models	Lista os modelos disponíveis.

Parâmetros de `/v1/chat/completions`

Campo	Tipo	Descrição
`model`	string	Identificador do modelo (ex.: `yris-1`).
`messages`	array	Lista de `{role, content}` — `system`, `user`, `assistant`.
`temperature`	number	Opcional. Criatividade da resposta (padrão 0,3).
`max_tokens`	integer	Opcional. Limite de tokens gerados.

Streaming: suportado — envie stream=true para receber Server-Sent Events com chunks chat.completion.chunk (formato OpenAI), encerrando com data: [DONE]. Com stream=false (padrão) a resposta vem completa, no formato chat.completion.

A Yris é experimental e pode se enganar. Confira o que for importante e não a use para decisões críticas.