Referência
Referência da API
Todas as rotas, o escopo de cada uma e o objeto de geração.
Rotas
| Método | Rota | Escopo |
|---|---|---|
GET | /v1/models | read |
GET | /v1/balance | read |
POST | /v1/generations | write |
GET | /v1/generations | read |
GET | /v1/generations/{id} | read |
GET | /v1/generations/{id}/outputs/{index} | read |
Base: https://staging-hypio.doti.gg/api/v1. Toda resposta leva Cache-Control: private, no-store, menos o download de arquivo.
Objeto de geração
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da geração. |
object | string | "generation" |
kind | string | video, image ou audio. |
model | string | O modelo pedido. |
status | string | queued, running, succeeded ou failed. |
prompt | string | O texto enviado. |
ratio, resolution | string | Vazios no áudio. |
durationSeconds, audio | número, booleano | Só no vídeo; null nos outros. |
count | número | null no vídeo. |
priceCredits | número | O preço em centavos de real. |
error | string | null | O motivo da falha. Veja Gerações. |
outputs | array | { index, url } por arquivo. |
createdAt, startedAt, finishedAt | string | null | ISO 8601, UTC. |
Objeto de saldo
{ object: "balance", availableCredits, planCredits, topupCredits, reservedCredits, suspended }.