Autenticação

Cada requisição leva uma chave de API secreta da conta ORYKSA.

Envia a chave no cabeçalho Authorization como bearer token (o cabeçalho X-API-Key também funciona). As chaves começam por oryk_live_.

curl https://api.oryksa.com/v1/account \
  -H "Authorization: Bearer oryk_live_YOUR_KEY"

const res = await fetch("https://api.oryksa.com/v1/account", {
  headers: { Authorization: "Bearer " + process.env.ORYKSA_API_KEY },
});

requests.get("https://api.oryksa.com/v1/account",
             headers={"Authorization": f"Bearer {os.environ['ORYKSA_API_KEY']}"})

Gerir chaves

Cria e revoga chaves na página Chaves de API. Até 10 chaves ativas por conta; uma por app ou ambiente é boa prática.
A chave completa é mostrada uma única vez. A ORYKSA só guarda um hash SHA-256, por isso uma chave perdida não se recupera: revoga-a e cria outra.
Uma chave revogada deixa de funcionar na hora.

Guarda as chaves no servidor. Uma chave de API dá acesso ao agente de IA, ao conhecimento e às conversas da conta. Nunca a metas num site, no pacote de uma app móvel ou num repositório público. Para sites usa o widget de chat, cujo token é público de propósito.

URL base e versões

Todos os endpoints estão em https://api.oryksa.com/v1 e devolvem sempre JSON. As respostas de erro trazem o cabeçalho ORYKSA-Version. Mudanças incompatíveis só sairão numa versão nova (/v2).