Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.faces.app/llms.txt

Use this file to discover all available pages before exploring further.

L’API Faces est une API REST qui vous permet de générer et de gérer de manière programmatique des decks interactifs et explorables. Pitches, portfolios, guides et propositions. Décrivez ce que vous voulez dans un prompt, et Faces le construit.

​
URL de base

https://faces.app/api/v1

​
Authentification

Incluez votre clé API en tant que Bearer token : 
Authorization: Bearer faces_your_key_here
Consultez Authentification pour savoir comment créer une clé.

​
Format des requests

  • Tous les corps de request sont en JSON (Content-Type: application/json)
  • Toutes les responses sont en JSON

​
Responses d’erreur

Les erreurs renvoient un corps JSON avec un champ error et, en option, un champ hint : 
{
  "error": "prompt is required",
  "hint": "POST /api/v1/projects/generate {\"prompt\": \"<text>\"}"
}
StatusSignification
400Corps ou paramètres de request invalides
401Clé API manquante ou invalide
404Ressource introuvable
429Rate limit dépassé (50 req/min)
500Erreur interne du serveur

​
Rate limits

Tous les endpoints partagent une limite de 50 requests par minute par utilisateur. En cas de dépassement :
  • Status de la response : 429
  • Headers : X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

​
Pagination

Les endpoints de liste utilisent une pagination basée sur cursor : 
# Première page
GET /projects?limit=10

# Page suivante (utilisez nextCursor de la response précédente)
GET /projects?limit=10&cursor=cm1abc123...