Documentation

Construire sur Beam.

Le chemin le plus court jusqu'à votre premier appel d'API.

Démarrage rapide.

Deux étapes jusqu'à votre première requête.

  1. 1

    Obtenez une clé d'API

    Les clés d'API ne se créent pas encore depuis l'application : demandez-nous (ou à qui gère votre déploiement) et nous en émettrons une limitée au strict nécessaire (chat, agents, embeddings ou connaissances). Gardez-la hors du code côté client.

  2. 2

    Envoyez votre première requête

    Écrivez à n'importe quel agent de votre espace de travail avec un jeton bearer. C'est la forme réelle de la requête, mais la réponse ne gère pas encore le streaming ni les appels d'outils.

    request.sh
    cURL
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    curl --request POST \
    --url $BEAM_URL/v1/chat \
    --header 'Authorization: Bearer $BEAM_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "message": "Résume la présentation au conseil du T3.",
    "agentId": "agent-analyst"
    }'
    # 200 OK · 412ms
    { "id": "chat_a1f9c4", "object": "chat.completion" }

La liste complète des endpoints, l'authentification et le comportement des limites de débit sont détaillés sur la page de référence de l'API.