Visão geral/OpenAPI/Criar e recuperar

Criar e recuperar

Carregue fontes, crie conteúdo e receba progressos, créditos e saídas.

Criar e recuperar

Todos os três produtos usam uma API de Creations, para que vídeos, imagens e resultados de aplicativos compartilhem a mesma lista, detalhes e fluxo de trabalho de saída.

Armazenamento de arquivos fonte

Todos os produtos aceitam input_file_ids. Faça um arquivo primeiro:

curl -s "https://api.kpainter.ai/openapi/v1/files" \  -H "Authorization: Bearer $KPAINTER_API_KEY" \  -F "file=@./handbook.pdf"

Exemplo de resposta:

{  "file_id": "file_xxx",  "name": "handbook.pdf",  "mime_type": "application/pdf",  "size_bytes": 248391}

Use o arquivo_id devolvido apenas dentro de criações de propriedade da mesma conta.

Criar

POST /creations

Áreas comuns:

campo Necessidade Significado
Tipo Sim Vídeo, imagem ou aplicativo
Imediatamente Sim O que criar
Instruções Não Requisitos adicionais
Ficheiro_File_ids Não IDs de origem previamente carregados
Max - Créditos Não O máximo de créditos autorizados para esta tarefa
Vídeo / Imagem / App Sim Exatamente uma configuração do objeto que corresponde ao tipo

O exemplo:

{  "type": "app",  "prompt": "Build a safety quiz with immediate feedback from the handbook",  "input_file_ids": ["file_xxx"],  "app": {    "language": "en"  }}

Lista e obtenha

GET /creations?page=1&page_size=20GET /creations?type=video&page=1&page_size=20GET /creations/{id}

campos de detalhes úteis:

campo Significado
Estatuto Planejamento, produção, descanso, pronto ou falhado
Progressão - PCT Progresso monotónico de 0 a 100
Estimado_reminiscentes_segundos Apenas quando fiável
- Créditos estimados Avaliação atual para esta tarefa
Créditos reais Créditos líquidos para uma tarefa bem sucedida
tem_usable_distribuição Se um resultado usável já existe
Disponível - Ações Ações que estão atualmente seguras para chamar
Revisão Um seguro Explicador de Vídeo quando disponível
Resultados - Código Um código de resultado seguro para usuários

As falhas comuns omitam os créditos reais. Uma ETA não confiável é esquecida em vez de supostamente.

Leia as saídas

GET /creations/{id}/outputs

Exibindo apenas as saídas devolvidas. Não digite uma URL ou use um arquivo intermediário não concluído.

Um fluxo de cliente estável

  1. Leia as capacidades.
  2. Solicite uma solicitação de criação válida.
  3. Faça a mesma criação a cada segundos.
  4. Leia os resultados depois de estar pronto.
  5. Se for interrompido, exibir as ações disponíveis e esperar para a ação requerida do usuário.
  6. Se falhar, mostre a razão segura e deixe que o usuário revise a solicitação.
  7. Se o estado da rede é incerto, obtenha a criação existente antes de criar outra.