Créer et récupérer
Tous les trois produits utilisent une API Creations, de sorte que la vidéo, l'image et les résultats des applications partagent la même liste, les détails et le flux de travail de sortie.
Téléchargez les fichiers source
Tous les produits acceptent input_file_ids. Téléchargez un fichier d’abord :
curl -s "https://api.kpainter.ai/openapi/v1/files" \ -H "Authorization: Bearer $KPAINTER_API_KEY" \ -F "file=@./handbook.pdf"Exemple de réponse :
{ "file_id": "file_xxx", "name": "handbook.pdf", "mime_type": "application/pdf", "size_bytes": 248391}Utilisez le fichier_id retourné uniquement dans les créations détenues par le même compte.
Créer
POST /creationsLes champs communs :
| champs | nécessaire | Signification |
|---|---|---|
| Type | Oui | Vidéo, image ou application |
| Rapidement | Oui | Que créer |
| Instructions | pas | Exigences supplémentaires |
| Mise à jour_file_ids | pas | Identifications de source précédemment téléchargées |
| max - crédit | pas | Crédits maximaux autorisés pour cette tâche |
| Vidéo / image / app | Oui | Exactement un type d'objet de réglage |
Exemple :
{ "type": "app", "prompt": "Build a safety quiz with immediate feedback from the handbook", "input_file_ids": ["file_xxx"], "app": { "language": "en" }}Liste et obtenez
GET /creations?page=1&page_size=20GET /creations?type=video&page=1&page_size=20GET /creations/{id}Des champs de détails utiles :
| champs | Signification |
|---|---|
| Statut | planification, production, pause, prêt ou échoué |
| progrès / PCT | Progrès monotonique de 0 à 100 |
| Évaluation_rémunération_seconds | Présentation uniquement lorsqu’elle est fiable |
| Évaluations - crédits | Prévisions actuelles pour cette tâche |
| Crédits réels | Crédits net pour une tâche réussie |
| a_usable_démission | Si un résultat utilisable existe déjà |
| Actions disponibles | Les actions qui sont actuellement sûres à appeler |
| Révision | Un outline de vidéo d'explication sécurisé quand disponible |
| Résultat / Code | Un code de résultat sécurisé |
Les échecs ordinaires omettent les crédits réels. Un ETA infaillible est omis plutôt qu'imaginé.
Lire les résultats
GET /creations/{id}/outputsIl n'y a que des sorties retournées. N'indiquez pas une URL ou utilisez un artifact intermédiaire infini.
Un flux client stable
- Lire les capacités.
- Soumettre une demande de création valide.
- Faites la même création toutes les quelques secondes.
- Lisez les sorties après la préparation.
- Si vous êtes en pause, afficher les actions disponibles et attendre l'action de l'utilisateur requise.
- En cas d'échec, indiquez la raison sûre et laissez l'utilisateur réviser la demande.
- Si l'état du réseau est incertain, obtenez la création existante avant de créer une autre.