Visão geral/OpenAPI/Visão geral

Visão geral

Saiba como trazer a criação KPainter para o seu produto.

Introduza o KPainter em seu produto

O KPainter OpenAPI é para desenvolvedores que querem criar conteúdo dentro de seu próprio produto, automação ou fluxo de trabalho de agente. Existem três produtos públicos:

Produto Tipo Melhor para
Vídeo explicativo Vídeo cursos, treinamento, SOPs, resumos de pesquisa, educação de produto e explicadores de conhecimento
Imagem com IA Imagem Posters, cobertores, ilustrações e conceitos de imagem única
Aplicação com IA APLICAÇÃO Páginas interativas, simulações, quizes e pequenas ferramentas

PDFs, apresentações, documentos e imagens são material fonte; eles não selecionam o produto de saída. Explicador de vídeo também pode usar um URL da página web como contexto fonte.

Base de URL

Todas as solicitações de produção começam aqui:

https://api.kpainter.ai/openapi/v1

Por exemplo, as capacidades completas são:

https://api.kpainter.ai/openapi/v1/capabilities

Um fluxo completo de criação

  1. Chame GET /me para verificar a chave API.
  2. Chame GET /capacidades para descobrir as opções atuais.
  3. Carregar anexos com POST / arquivos.
  4. Crie um vídeo, imagem ou aplicativo com POST/creations.
  5. Poll GET /creations/{id} para status e progresso.
  6. Leia GET /creations/{id}/outputs quando a entrega está disponível.
  7. Use mensagens para aperfeiçoar um vídeo de explicação. Quando uma tarefa é interrompida, execute apenas uma ação listada em acções disponíveis.

Os principais pontos finais

Finalidade Objetivo
GET / Saúde Verifique a disponibilidade do serviço
Me / Me Verifique a conta atual
Capacidades / Capacidades Descubra produtos, parâmetros, templates e modelos
Posts / Arquivos Armazenamento de arquivos de entrada
POST / Criação Criar conteúdo
GET / Criações Lista das criações da conta
GET / criações /{id} Leia status, progresso, ETA, créditos e revisão
POST / Criações / {id} / Mensagens Faça um vídeo de explicação
POST / Criações /{id} / Ações Continue a última tarefa despedida
GET / criações /{id} / outputs Leia QA-aprovações

O que manter em mente

  • Identificar com uma chave API.
  • Os campos de solicitação e resposta públicos usam snake_case.
  • Envie apenas valores de parâmetros devolvidos por capacidades.
  • Um fracasso comum não relata créditos reais.
  • ETA é omitida quando não pode ser estimada de forma confiável.
  • Leia os resultados usáveis dos pontos de saída após a conclusão, em vez de construir URLs de armazenamento.