LogoLogoDocumentação da API
LogoLogoDocumentação da API
Página inicial
Visão geralAutenticação e idempotênciaGeração de imagensEdição de imagensConversão de imagensJobs e espera limitadaCréditosErrosLimites de requisição e concorrênciaChangelog da API
Documentação da API

Visão geral

Integre a geração, edição e conversão de imagens da SciDraw AI

A API REST da SciDraw AI oferece endpoints estáveis baseados em jobs para geração de imagens, edição de imagens e conversão de formatos.

URL base: https://sci-draw.com

Especificação legível por máquina: OpenAPI JSON · OpenAPI YAML

Os dois arquivos descrevem esta mesma API no formato OpenAPI. Importe qualquer um deles no Postman ou no Insomnia e todos os endpoints já vêm preenchidos; passe para um gerador de código e você obtém um cliente tipado; entregue a um agente de IA e ele consegue chamar a API sem que você escreva a requisição na mão. Os dois formatos são intercambiáveis — use o que a sua ferramenta aceitar.

Início rápido

  1. Crie uma chave de API em Configurações → Chaves de API e selecione apenas os escopos de que a sua integração precisa.
  2. Envie a chave como Authorization: Bearer sd_....
  3. Adicione um Idempotency-Key único a toda requisição de criação.
  4. Guarde o ID do job retornado e consulte a URL de Location até chegar a succeeded, failed ou canceled.
curl https://sci-draw.com/api/v1/images/generations \
  -H 'Authorization: Bearer sd_YOUR_KEY' \
  -H 'Idempotency-Key: order-7842-figure-1' \
  -H 'Content-Type: application/json' \
  -d '{
    "prompt": "A clean scientific illustration of exosome biogenesis",
    "aspect_ratio": "16:9",
    "resolution": "2K",
    "count": 1
  }'

Uma requisição de criação normalmente retorna 202 Accepted, um objeto de job, um cabeçalho Location e Retry-After: 2. Você pode acrescentar Prefer: wait=10 para aguardar até dez segundos. Aguardar nunca muda a semântica do job: o status só é 200 se o job já estiver concluído; caso contrário, continua 202.

Endpoints

MétodoCaminhoEscopo
POST/api/v1/images/generationsimages:generate
POST/api/v1/images/editsimages:edit
POST/api/v1/images/conversionsimages:convert
GET/api/v1/jobs/{job_id}jobs:read
GET/api/v1/creditscredits:read

Todas as respostas são envelopes JSON. Toda resposta traz um X-Request-Id; informe esse ID ao falar com o suporte. As únicas referências de arquivo retornadas são as URLs de saída e os IDs públicos de arquivo. O roteamento de capacidades é gerenciado pela SciDraw AI.

Autenticação e idempotência

Chaves de API, escopos, IDs de requisição e retentativas seguras

Sumário

Início rápido
Endpoints