Descripción general/OpenAPI/Crear y recuperar

Crear y recuperar

Cargue fuentes, cree contenido y recupere progreso, créditos y resultados.

Crear y recuperar

Todos los tres productos utilizan una API Creations, por lo que los resultados de vídeo, imagen y aplicación comparten la misma lista, detalles y flujo de trabajo de salida.

Descargar archivos de fuente

Todos los productos aceptan input_file_ids. Descargar un archivo primero:

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

Exemplos de respuesta:

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

Utilice el archivo_id devuelto sólo dentro de las creaciones propiedad de la misma cuenta.

Crear

POST /creations

Los campos comunes:

Campo Necesidad Significado
Tipo Video, imagen o aplicación
Pronto ¿Qué crear
Instrucciones No Requisitos adicionales
Inicio_file_ids No Identificaciones de fuente previamente cargadas
Max - Créditos No El máximo de créditos autorizados para esta tarea
Video / imagen / aplicación Exactamente un objeto de configuración que se ajusta al tipo

El ejemplo:

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

Lista y Obtener

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

Los campos de detalles útiles:

Campo Significado
Estatuto Planificación, producción, descanso, preparado o fracasado
Progreso / Pct Progreso monotónico de 0 a 100
El tiempo de la vida_reminiscentes_seconds Sólo cuando es confiable
Credencias - Credencias Estimaciones actuales para esta tarea
Realidad - Créditos Créditos netos para una tarea exitosa
Has_usable_entrega Si un resultado usable ya existe
Disponible - Acciones Acciones que actualmente son seguras para llamar
Revisión Un video seguro cuando está disponible
Resultado_Código Un código de salida seguro para el usuario

Los errores habituales omiten los créditos reales. Una ETA no fiable se omite en lugar de esconder.

Leer los resultados

GET /creations/{id}/outputs

Sólo se devuelven las fuentes. No indique una URL o utilice un artefato intermedio indefinido.

Un flujo de clientes estable

  1. Leer las capacidades.
  2. Solicita una solicitud de creación válida.
  3. Póngase la misma creación cada unos segundos.
  4. Lea las entradas después de estar listas.
  5. Si se pausa, muestra las acciones disponibles y espera la acción requerida del usuario.
  6. En caso de fracaso, muestra la razón segura y deja que el usuario revise la solicitud.
  7. Si el estado de la red es incerto, obtenga la creación existente antes de crear otra.