​
Ce dont vous avez besoin

Avant d’envoyer des requêtes, vous avez besoin de :

  1. Une clé API Ocoya
  2. Un ID de marque
  3. Des IDs de profils sociaux si vous voulez créer ou programmer des posts

​
Obtenir une clé API

Créez ou copiez une clé API depuis vos paramètres API Ocoya.

Create API key

Les clés API sont destinées à une utilisation côté serveur. Ne les exposez pas dans du JavaScript côté navigateur, des applications mobiles ou des dépôts publics.

​
URL de base

Tous les exemples REST API utilisent :

https://www.app.ocoya.com/api/_public/v1

​
Envoyer votre première requête

La façon la plus rapide de vérifier que votre clé API fonctionne est d’appeler /me.

curl -X GET "https://www.app.ocoya.com/api/_public/v1/me" \
  -H "X-API-Key: YOUR_API_KEY"

Si la clé est valide, l’API renvoie votre contexte utilisateur.

{
  "id": "clx354swx0006ghoatnjknv98",
  "name": "Ocoya Support",
  "email": "support@ocoya.com"
}

​
Parcours de publication typique

1

Lister les marques

Appelez GET /brands et choisissez la marque depuis laquelle vous voulez publier.

2

Connecter des profils sociaux

Si la marque n’a pas encore de profils connectés, appelez POST /social-profiles/connection-url et ouvrez l’url renvoyée dans un navigateur.

3

Lister les profils sociaux

Appelez GET /social-profiles?brandId=BRAND_ID pour trouver les IDs de profils connectés.

4

Résoudre le contexte optionnel

Appelez GET /hashtag-libraries?brandId=BRAND_ID lorsqu’un brouillon IA doit utiliser un contexte de hashtags enregistré.

5

Créer un brouillon ou un post programmé

Appelez POST /post?brandId=BRAND_ID avec une légende, des URLs de médias, des IDs de profils sociaux cibles et un scheduledAt optionnel.

6

Créer un brouillon IA

Appelez POST /post/ai?brandId=BRAND_ID avec un prompt lorsque vous voulez qu’Ocoya génère d’abord la légende.

7

Créer une campagne IA

Appelez POST /campaigns?brandId=BRAND_ID pour mettre en file d’attente la génération d’une campagne multi-posts et recevoir immédiatement une réponse GENERATING.

8

Gérer les posts

Utilisez GET /post, PATCH /post/{postId} et DELETE /post/{postId} pour inspecter, reprogrammer ou supprimer des posts.

​
Créer un post

Utilisez scheduledAt lorsque vous voulez un post programmé. Omettez-le lorsque vous voulez un brouillon.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/post?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "caption": "Launching our summer campaign today.",
    "mediaUrls": ["https://example.com/image.jpg"],
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "scheduledAt": "2026-07-01T09:00:00Z"
  }'

​
Connecter un profil social

Utilisez POST /social-profiles/connection-url lorsque vous avez besoin d’une URL de navigateur pour connecter un nouveau profil social.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/social-profiles/connection-url?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"instagram"}'

Ouvrez l’url renvoyée tout en étant connecté à Ocoya.

​
Créer un brouillon IA

Utilisez POST /post/ai lorsque vous voulez qu’Ocoya génère la légende à partir d’un prompt avant de créer le brouillon.

Utilisez hashtagLibraryId et referenceDesignIds lorsque vous voulez que le brouillon utilise une bibliothèque de hashtags enregistrée ou le contexte d’un modèle Studio.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/post/ai?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Write a friendly launch post for our new analytics dashboard.",
    "tone": "friendly",
    "postLength": "medium",
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "hashtagLibraryId": "HASHTAG_LIBRARY_ID",
    "generateImage": true,
    "referenceUrls": ["https://example.com/reference.png"],
    "referenceDesignIds": ["STUDIO_DESIGN_ID"]
  }'

​
Créer une campagne IA

Utilisez POST /campaigns lorsque vous voulez qu’Ocoya génère en arrière-plan une campagne multi-posts.

La réponse est renvoyée immédiatement avec le statut GENERATING. Utilisez hashtagLibraryId lorsque la campagne doit utiliser une bibliothèque de hashtags enregistrée.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/campaigns?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Summer launch campaign for our ecommerce analytics dashboard, aimed at marketing teams already using spreadsheets. Confident, practical tone.",
    "goal": "launch",
    "duration": 10,
    "count": 6,
    "postLength": "medium",
    "hashtagLibraryId": "HASHTAG_LIBRARY_ID",
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "generateMedia": true
  }'

​
MCP vs REST API

Utilisez la REST API pour les systèmes backend qui savent déjà exactement ce qu’ils doivent faire.

Utilisez MCP lorsque vous voulez que des clients IA comme Claude, Codex ou ChatGPT découvrent et appellent les outils Ocoya après que l’utilisateur a approuvé l’accès OAuth.