Documentation
Cycle du serveur OpenHands
Bientôt disponible. Contrat d’API prévu, sujet à changement. Ces fonctions ne sont pas encore offertes en production.
Authentification et chemin
Préfixe : /v1/customer/tenants/{tenantId}/sandboxes/{sandboxId}. Les requêtes utiliseront un jeton d’accès bearer ou une clé API de l’espace de travail. Les droits de bac à sable et de dépôt indiqués sont des permissions, pas des scopes hérités. Une clé all:all fonctionnera aussi, dans les limites des permissions actuelles de son créateur. Le relais SSH utilise son ticket plutôt qu’un jeton bearer.
GET, POST et DELETE /agent
GET exigera sandboxes:read ou sandboxes:write et retourne 200. POST exigera sandboxes:write. Son seul corps facultatif est {}. POST retourne 202 pour une session mise en file ou existante. DELETE exige sandboxes:write et retourne 200 avec stopped ou idle. DELETE est idempotent et reste permis après la désactivation de la fonction. Un état actif ne confirme pas que le serveur est prêt.
Champs et disponibilité
SandboxAgent contient enabled, status (idle, active, stopped ou failed), session_id et exit_code pouvant valoir null, reason, tasks_available, task_unavailable_reason (vide, model_proxy_required, model_limit ou permission_required) et readiness=unverified. Le démarrage exige la fonction activée, l’image OpenHands et un bac à sable actif. Sinon, POST retourne 503 avec sandbox_agent_unavailable, sandbox_exec_unavailable ou sandboxes_unavailable. Les lectures et les sorties conservées restent accessibles après la désactivation. Toutes les lectures ne retournent pas 503 dans cet état.
GET /agent/output
Cette route exige la permission de lecture. Le paramètre session_id est obligatoire (sxe_ et 24 caractères hexadécimaux). Le paramètre after est un entier facultatif de 0 ou plus, 0 par défaut. Une réponse 200 est en application/x-ndjson. Chaque ligne stdout ou stderr porte seq et data en base64, puis les champs exit à la fermeture. Limites prévues : 8 Mio de sortie serveur, conservée jusqu’à 24 heures après la fermeture. Les lecteurs se renouvellent après 110 secondes. Reprenez avec le dernier seq. La déconnexion n’annule pas le serveur. Un code 404 avec sandbox_agent_not_started indique que le serveur n’a pas démarré. Un code 409 avec sandbox_agent_session_changed exige une nouvelle lecture de l’état. Les autres états sont 400, 401, 403, 500 et 503.