SDK

SDK TypeScript typé pour l'API Raconte : @raconte/node-sdk.

@raconte/node-sdk est le SDK TypeScript typé pour l’API Raconte. Il expose la même surface que l’API REST (interviews et invitations) sous forme de fonctions typées, générées depuis la spec OpenAPI publique, avec des schémas Zod pour la validation. Il utilise le fetch natif et est livré en ESM.

Préférez le CLI pour les scripts et le terminal ; utilisez le SDK dans une application TypeScript ou Node.

Installation

npm install @raconte/node-sdk

Démarrage rapide

Créez une clé d’API d’organisation depuis Paramètres → API, puis :

import { createRaconteClient, interviewsControllerList } from '@raconte/node-sdk'

const client = createRaconteClient({ apiKey: process.env.RACONTE_API_KEY! })

const { data, error } = await interviewsControllerList({ client })
if (error)
  throw new Error(`Échec de la requête : ${JSON.stringify(error)}`)

console.log(data)

Chaque fonction du SDK reçoit le client via son option client et renvoie { data, error, response } (pas d’exception sur les erreurs HTTP) : vérifiez error avant d’utiliser data.

createRaconteClient accepte { apiKey }. La clé est envoyée en Authorization: Bearer <clé>.

Schémas de validation

Les schémas Zod de chaque requête et réponse sont disponibles via le sous-chemin /zod :

import { zCreateInterviewSchema } from '@raconte/node-sdk/zod'

const input = zCreateInterviewSchema.parse(payload)

Ce que vous pouvez faire

  • Interviews : lister, créer, récupérer, mettre à jour, archiver, restaurer, logs, régénérer intro / premier message.
  • Invitations : lister, créer, créer en masse, récupérer, mettre à jour, envoyer, annuler, réactiver, archiver, restaurer, logs, URL audio d’un message.
  • Voices : lister le catalogue et obtenir une URL audio d’aperçu (les endpoints publics, sans auth, où l’on choisit un voiceId).

Voir la référence API interactive pour les schémas complets de requêtes et réponses.