La référence de l'API est publiée en anglais.

Read the cheap host-local authentication signal for an adapter type

GET/api/companies/{companyId}/adapters/{type}/auth-signal
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Read the cheap host-local authentication signal for an adapter type.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.
typestringObligatoireThe type's id.

Paramètres de requête

environmentIdstringFacultatif

Réponses

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Agent runtimes