Reference
API reference
Every route of the public API, generated from the OpenAPI 3.1 contract.
This reference is generated on every site build from the OpenAPI 3.1 contract served by the API, so it cannot drift from what the API accepts. Descriptions come from the contract and are written in French. Base URL: https://app.fanconvert.ai/public/v1.
Routes
- API key
GET /public/v1/me— La clé utilisée
- Creators
GET /public/v1/creators— Les créatrices de la cléGET /public/v1/creators/{creator_id}— Une créatrice
- Conversations
GET /public/v1/creators/{creator_id}/conversations— Les conversations d'une créatriceGET /public/v1/creators/{creator_id}/conversations/{conversation_id}/messages— Les messages d'une conversation
- Fans
GET /public/v1/creators/{creator_id}/labels— Les étiquettes de fans d'une créatriceGET /public/v1/creators/{creator_id}/fans/{conversation_id}— La fiche d'un fan : étiquettes et note de l'équipePUT /public/v1/creators/{creator_id}/fans/{conversation_id}/note— Écrire la note de l'équipe sur un fanPUT /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}— Poser une étiquette sur un fan (sans effet si elle y est déjà)DELETE /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}— Retirer une étiquette d'un fan
- AI
GET /public/v1/creators/{creator_id}/conversations/{conversation_id}/ai— Qui répond à ce fan : l'IA, une personne, ou personnePOST /public/v1/creators/{creator_id}/conversations/{conversation_id}/ai/pause— Mettre l'IA en pause sur ce fan (« Arrêter le chatting »), MYMPOST /public/v1/creators/{creator_id}/conversations/{conversation_id}/ai/resume— Rendre ce fan à l'IA (« Relancer le chatting »), MYM
- Sales and statistics
GET /public/v1/sales— Les ventes, par plateformeGET /public/v1/statistics/creators— Revenus et envois par créatrice sur une période
- Scripts and media
GET /public/v1/creators/{creator_id}/scripts— Les scripts de vente d'une créatriceGET /public/v1/creators/{creator_id}/media— La médiathèque d'une créatrice
- Emergencies
GET /public/v1/emergencies— Les urgences : ce qui attend un humain
- Webhooks
POST /public/v1/webhooks— Enregistrer une adresse qui recevra les événementsGET /public/v1/webhooks— Les webhooks de cette cléDELETE /public/v1/webhooks/{endpoint_id}— Désactiver un webhook (son journal est gardé)GET /public/v1/webhooks/{endpoint_id}/deliveries— Le journal des livraisons, les plus récentes d'abordPOST /public/v1/webhooks/{endpoint_id}/ping— Envoyer un événementping(aucune donnée) pour tester la réception
Last updated on