kreatoai/Documentation API

Espace de travail

Un espace de travail = une marque. GET /v1/workspace renvoie son identité, son profil de marque (celui qui nourrit la génération de scripts), le plan en cours et le solde de crédits. C'est l'appel à faire en premier dans une intégration ou un agent : il dit qui vous êtes et ce que vous pouvez encore faire.

Principe

GET
/v1/workspace

Identité, marque, plan et crédits

Scope : workspace:read. Toute clé disposant d'un scope d'action (publish:posts, media:write) y a également accès — connaître son espace est un prérequis pour agir dessus.

Lire l'espace

curl https://api.kreatoai.com/v1/workspace \
  -H "x-api-key: sk-kre-v1-votre_cle"
// 200 OK
{
  "id": "0e98ae67-…",
  "name": "FootballWorld",
  "description": "Le meilleur du football, chaque jour.",
  "currency": "EUR",
  "logoUrl": "https://media.kreatoai.com/…/logo.png",
  "timezone": "Europe/Paris",
  "brand": {
    "targetAudience": "Fans de football 18-35 ans",
    "uniqueValueProp": "Des moments cultes racontés en 30 secondes",
    "voiceTone": "energetic",
    "contentTopics": ["Messi", "Ligue des champions", "transferts"]
  },
  "plan": {
    "name": "STARTER",
    "label": "Creator",
    "subscribed": "STARTER",
    "status": "active",
    "periodEnd": "2026-09-25T00:00:00.000Z",
    "monthlyCredits": 400,
    "freePublicationsLeft": null
  },
  "credits": {
    "balance": 42,
    "cost": { "IMAGE": 2 }
  },
  "createdAt": "2026-08-23T15:50:50.000Z"
}

Champs

ChampDescription
timezoneFuseau horaire de la personne connectée, ou du propriétaire de l’espace pour une clé API (identifiant IANA) ; null s’il n’est pas encore connu
brandProfil de marque : nom, ton, sujets et couleurs de l’espace
plan.nameIdentifiant du plan réellement actif maintenant : FREE, STARTER, GROWTH ou AGENCY
plan.labelNom commercial de ce plan, à montrer à l’utilisateur : Free, Creator, Studio ou Agency
plan.subscribedPlan souscrit. Peut différer de plan.name si l’abonnement est arrivé à échéance
plan.statusÉtat de l’abonnement chez le prestataire de paiement : active, cancelled, on_hold… ; null sans abonnement
plan.periodEndFin de la période payée. Un abonnement annulé garde l’accès jusque-là
plan.monthlyCreditsDotation mensuelle du plan actif, en crédits
plan.freePublicationsLeftPublications qu’un compte gratuit peut encore créer ce mois-ci (dix offertes par mois UTC) ; null pour un abonné
credits.balanceSolde disponible. Les crédits non utilisés se reportent tant que l’abonnement est actif
credits.costTarif d’une image, pour n’avoir aucun prix à recopier