Referência
Conteúdo principalReferência da API
Todos os endpoints da API PopNow em uma página, com links para o contrato OpenAPI completo.
O contrato completo e legível por máquina é o openapi.yaml (OpenAPI 3.1). Importe no Postman, no Insomnia ou num gerador de código, ou entregue a um agente de IA. Esta página é o mapa em escala humana.
- URL base:
https://api.popnow.ai/api/v1(rotas compatíveis com a OpenAI:https://api.popnow.ai/v1) - Autenticação:
Authorization: Bearer sk-popnow-…em toda requisição - Envelope:
{ "code", "msg", "data", "request_id" };code: 200é sucesso - Valores: créditos inteiros (
credits,maxCredits…), cada um também como string em dólares; 1 crédito = US$ 0,01
Tarefas
| Método e caminho | O que faz | Página |
|---|---|---|
POST /jobs/createTask | Cria uma tarefa de geração (?wait= opcional, até 60 s) | Tarefas |
GET /jobs/recordInfo?taskId= | Lê o estado e o resultado de uma tarefa | Tarefas |
GET /jobs | Lista as tarefas desta chave | Tarefas |
POST /jobs/quote | Cota uma requisição sem executá-la | Cobrança |
POST /jobs/retry | Tarefa nova a partir de uma que falhou ou expirou | Tarefas |
POST /jobs/purge | Apaga o conteúdo de uma tarefa concluída | Tarefas |
Modelos
| Método e caminho | O que faz | Página |
|---|---|---|
GET /models | Todos os modelos disponíveis com preços (?includeSchema=1 para os schemas de entrada) | Modelos |
GET /models/{model} | Um modelo, com o schema de entrada | Modelos |
Arquivos e assets
| Método e caminho | O que faz | Página |
|---|---|---|
POST /common/upload-url | Ticket para upload direto | Mídia |
POST /files/{fileId}/commit | Conclui um upload e devolve o URI popnow:// | Mídia |
POST /files/import | Importa um arquivo LoRA de um link | Assets |
POST /common/download-url | Novo link assinado para o resultado de uma tarefa | Mídia |
GET /assets, POST /assets | Lista ou salva assets | Assets |
GET, PATCH, DELETE /assets/{assetId} | Lê, renomeia ou apaga um asset | Assets |
GET /assets/entities | Seus personagens | Assets |
GET /assets/usage | Plano de armazenamento e uso | Assets |
Conta
| Método e caminho | O que faz | Página |
|---|---|---|
GET /chat/credit | Saldo: disponível, reservado, total | Cobrança |
GET /usage | Uso desta chave por dia e por modelo | Cobrança |
Compatível com OpenAI Videos (/v1)
| Método e caminho | O que faz | Página |
|---|---|---|
POST /v1/videos | Cria uma tarefa de vídeo | OpenAI Videos |
GET /v1/videos/{id} | Lê a tarefa | OpenAI Videos |
GET /v1/videos/{id}/content | Redireciona para o arquivo | OpenAI Videos |
GET /v1/models | Lista de modelos no formato da OpenAI | OpenAI Videos |
Cabeçalhos comuns
| Cabeçalho | Direção | Significado |
|---|---|---|
Idempotency-Key | Requisição | Deixa seguras por 24 horas as novas tentativas de uma escrita (Idempotência) |
Accept-Language | Requisição | Idioma das mensagens de erro (Erros) |
X-PopNow-Retention | Requisição | Encurta a retenção do conteúdo de uma tarefa, em segundos |
X-Request-Id | Resposta | Igual ao request_id; informe ao suporte |
X-RateLimit-Limit, X-RateLimit-Remaining, Retry-After | Resposta | Limites de taxa (Limites de taxa) |

