Développeurs

Documentation de l’API

Générez des vidéos depuis votre application. Authentification par jeton, réponses JSON, webhooks à la fin du rendu.

Obtenir une clé Voir les endpoints

Authentification

Chaque requête porte l’en-tête Authorization: Bearer VOTRE_CLE. Les clés se créent depuis votre profil.

Limites

Le débit dépend de votre offre. Un dépassement renvoie un code 429 avec l’en-tête Retry-After.

Webhooks

Déclarez une URL dans votre espace : chaque changement d’état vous est notifié, signé HMAC.

Endpoints

GET /api/v1/effects Lister les effets disponibles

Retourne le catalogue actif, avec le coût en crédits et la durée de chaque effet.

Réponse

{
  "data": [
    { "code": "FX-014", "name": "Coup franc", "credit_cost": 1, "duration_seconds": 5 }
  ]
}

POST /api/v1/generations Lancer un rendu

Crée un rendu à partir d’un effet et d’une image accessible publiquement.

effect: Code de l’effet (ex. FX-014).
image_url: URL HTTPS publique de la photo source.
prompt: Complément de description, facultatif.

Réponse

{
  "uuid": "9f1c…",
  "status": "queued",
  "credits_used": 1
}

GET /api/v1/generations Lister vos rendus

Retourne l’historique paginé des rendus rattachés à la clé utilisée.

Réponse

{
  "data": [
    { "uuid": "9f1c…", "status": "completed", "effect": "FX-014" }
  ]
}

GET /api/v1/generations/{uuid} Suivre un rendu

Retourne l’état courant, la progression et l’URL de la vidéo une fois terminée.

Réponse

{
  "uuid": "9f1c…",
  "status": "completed",
  "progress": 100,
  "video_url": "https://…/render.mp4"
}

Exemple complet

curl -X POST https://klyp.g-hyksos.com/api/v1/generations \
  -H "Authorization: Bearer VOTRE_CLE" \
  -H "Content-Type: application/json" \
  -d '{"effect":"FX-014","image_url":"https://exemple.com/photo.jpg"}'

Une question sur l’intégration ?

Écrire à l’équipe