Présentation/OpenAPI/Présentation

Présentation

Apprenez comment mettre la création KPainter dans votre produit.

Introduisez KPainter dans votre produit

KPainter OpenAPI est destiné aux développeurs qui veulent créer du contenu dans leur propre produit, automation ou flux de travail d'agent. Il présente trois produits publics :

Produit Type Idéal pour
Vidéo explicative Vidéo cours, formation, SOPs, résumés de recherche, éducation des produits et explicateurs de connaissances
Image IA image Posters, couvertures, illustrations et concepts d'image unique
Application IA Appes Pages interactives, simulations, quiz et petits outils

PDF, présentations, documents et images sont des matériaux source ; ils ne sélectionnent pas le produit de sortie. Explainer Video peut également utiliser une URL de page Web comme contexte source.

URL de base

Toutes les demandes de production commencent ici :

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

Par exemple, les capacités complètes finissent par :

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

Un flux de création complet

  1. Appelez GET /me pour vérifier la clé API.
  2. Appelez GET /capacités pour découvrir les options actuelles.
  3. Téléchargez les annexes avec POST /Files.
  4. Créer un seul vidéo, image ou application avec POST/creations.
  5. Poll GET /creations/{id} pour le statut et le progrès.
  6. Read GET /creations/{id}/outputs lorsque la livraison est disponible.
  7. Utilisez des messages pour réparer un Video Explainer. Lorsqu’une tâche s’arrête, effectuez uniquement une action énumérée dans les actions disponibles.

Principales finitions

Endpoint Objectif
Accueil / Santé Vérifier la disponibilité du service
Résultat / Me Vérifier le compte actuel
Capacités / Capacités Découvrez les produits, paramètres, modèles et modèles
POST / fichier Télécharger les fichiers d'entrée
Posts / Créations Créer du contenu
Création / Création Liste des créations du compte
Création / Création{id} Lire l'état, le progrès, l'ETA, les crédits et la révision
POST / Créations / {id} / Messages Récupérer une vidéo d'explication
POST / Créations / {id} / actions Continuer la dernière tâche suspendue
GET / Créations/{id}/outputs Lire les outils approuvés par QA

Que garder à l’esprit

  • Authenticate avec une clé API Porteur.
  • Les champs de demande et de réponse publiques utilisent snake_case.
  • Envoyez uniquement les valeurs paramétraires retournées par les capacités.
  • Un échec ordinaire ne rapporte pas de crédits réels.
  • ETA est omis quand il ne peut pas être estimé de manière fiable.
  • Lisez les résultats utiles des outils à la fin après la fin, au lieu de construire des URL de stockage.