Descripción general/OpenAPI/Descripción general

Descripción general

Aprenda cómo incorporar la creación KPainter a su producto.

Introducir KPainter en tu producto

KPainter OpenAPI es para los desarrolladores que desean crear contenido dentro de su propio producto, automática o flujo de trabajo de agentes. Exponen tres productos públicos:

Producto Tipo Mejor para
Vídeo explicativo Vídeo cursos, formación, SOPs, resumen de investigación, educación de productos y explicadores de conocimientos
Imagen con IA Imagen carteles, cubiertas, ilustraciones y conceptos de imagen única
Aplicación con IA Aplicaciones Páginas interactivas, simulaciones, quizas y pequeñas herramientas

PDFs, presentaciones, documentos y imágenes son material de fuente; no seleccionan el producto de salida. Explainer Video también puede utilizar una URL de la página web como contexto de fuente.

Bases de URL

Todas las solicitudes de producción comienzan aquí:

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

Por ejemplo, las capacidades completas son:

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

Un flujo creativo completo

  1. Póngase en contacto con GET /me para verificar la clave API.
  2. Póngase en contacto con GET/capacidades para descubrir las opciones actuales.
  3. Descargar archivos con POST/Files.
  4. Crea un vídeo, imagen o aplicación con POST/creations.
  5. Poll GET /creations/{id} para el estado y el progreso.
  6. Leer GET /creations/{id}/outputs cuando la entrega está disponible.
  7. Utilice mensajes para perfeccionar un vídeo de explicación. Cuando una tarea se detiene, sólo realiza una acción en la lista disponible_acciones.

Los principales puntos finales

El punto final Objetivo
Salud / Salud Verificar la disponibilidad del servicio
Tiene / Me Verificar la cuenta actual
Capacidades / Capacidades Descubre productos, parámetros, templatos y modelos
Páginas / Files Descargar archivos de entrada
POST / Creaciones Crear contenido
Creaciones / Creaciones Listar las creaciones de la cuenta
Creaciones / Creaciones{id} Leer el estado, el progreso, ETA, créditos y revisión
POST / Creaciones/{id}/Mensaje Descargar un video de explicación
POST / creaciones /{id} / acciones Continúa la última tarea de descanso
GET / creaciones /{id} / resultados Leer los resultados aprobados por QA

¿Qué tener en mente

  • Autenticado con una llave de API.
  • Los campos de solicitud pública y de respuesta utilizan snake_case.
  • Enviar sólo valores de parámetros devueltos por capacidades.
  • Un fracaso ordinario no informa de créditos reales.
  • ETA se omite cuando no se puede estimar de manera fiable.
  • Leer los resultados usables de los puntos finales de salida después de la finalización en lugar de construir URL de almacenamiento.