Démarrage rapide avec Synchain De l'inscription à votre premier appel d'API

Étape par étape

1. Créer un compte gratuit

   Inscrivez-vous avec votre adresse e-mail, puis créez un projet ou rejoignez-en un grâce à un lien d'invitation. Tout ce qui suit s'applique aux projets dont votre compte fait partie.

2. Installer Synchain Bridge dans votre DAW (facultatif, pour l'audio DAW en direct)

   Synchain Bridge est le plug-in DAW — VST3 sous Windows, VST3 et AU sur les Mac Apple Silicon — qui envoie l'audio de votre session dans Creative Space. Passez cette étape si vous n'avez besoin que de la CLI ou de l'API. Les téléchargements et les étapes d'installation se trouvent sur la page de téléchargement.

3. Installer la CLI

   La CLI Synchain nécessite Node.js 20 ou une version ultérieure. Installez-la globalement depuis npm, puis vérifiez la version installée. La référence des commandes décrit chaque commande et chaque option.

   npm i -g @synchain/cli
   synchain --version

4. Créer une clé CLI

   Connectez-vous, ouvrez Réglages du compte → Accès CLI, cochez les sections auxquelles la clé aura accès et générez une clé. Elle ne s'affiche qu'une seule fois : copiez-la tout de suite ; en générer une nouvelle révoque l'ancienne. Dans chaque projet, un administrateur définit ce que la CLI peut atteindre sous Réglages du projet → Accès CLI du projet. La CLI n'accède à une section que si votre clé et le projet l'autorisent tous les deux ; Fichiers du projet et Discussion sont activés par défaut.

5. Se connecter et choisir un projet

   synchain login demande l'URL de base (Entrée pour garder la valeur par défaut), puis votre clé, en saisie masquée. La clé n'est jamais acceptée en argument de ligne de commande, où elle finirait dans l'historique du shell ; en CI, placez-la dans la variable d'environnement SYNCHAIN_TOKEN et ajoutez --base-url pour qu'aucune question ne soit posée. Listez ensuite les projets accessibles et rendez-en un actif : project use accepte un ID affiché par project ls.

   synchain login
   synchain project ls
   synchain project use <project-id>

6. Envoyer un fichier et le relire

   Envoyez un fichier local à la racine du projet actif, puis listez en JSON les fichiers de la racine pour vérifier qu'il est bien arrivé. Remplacez ./mix.wav par un vrai chemin sur votre machine.

   Nécessite @synchain/cli 0.9.0 ou une version ultérieure.

   synchain files upload ./mix.wav
   synchain files ls --format json

7. Appeler l'API directement

   La même clé sert de jeton Bearer pour l'API HTTP. N'écrivez pas la clé dans une commande export, où elle resterait dans l'historique du shell : lancez read -rs SYNCHAIN_TOKEN && export SYNCHAIN_TOKEN, collez la clé et appuyez sur Entrée (rien ne s'affiche). La requête ci-dessous renvoie alors en JSON votre compte et les projets auxquels vous avez accès. Ces commandes supposent bash ou zsh (macOS, Linux, WSL ou Git Bash).

   curl -H "Authorization: Bearer $SYNCHAIN_TOKEN" https://dev.synchain.ca/api/user/me

Pour les agents IA

Un agent devrait commencer par /AGENTS.md et le guide d'installation pour agents. Trois réflexes couvrent l'essentiel : lire l'arborescence des commandes en JSON, répéter chaque écriture avec --dry-run avant de l'exécuter pour de bon, et laisser synchain doctor vérifier la configuration locale sans appeler l'API. Transmettez la clé à un agent via SYNCHAIN_TOKEN, jamais dans une conversation ni sur une ligne de commande.

Nécessite @synchain/cli 0.9.0 ou une version ultérieure.

synchain --help --format json
synchain files rm <file-id> --dry-run --format json
synchain doctor --json