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

Create a tool application

POST/api/companies/{companyId}/tools/applications
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

Create a tool application.

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.

Corps de la requête

application/json · obligatoire

applicationKeystringFacultatif1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
namestringObligatoire1–160 characters
descriptionstring | nullFacultatifat most 4000 characters
typestringObligatoireone of: "rest_api", "mcp_http", "mcp_stdio", "veyra_plugin", "a2a", "chat"
statusstringFacultatifone of: "draft", "active", "disabled", "archived"
pluginIdstring (uuid) | nullFacultatif
ownerAgentIdstring (uuid) | nullFacultatif
ownerUserIdstring | nullFacultatif
metadataobject | nullFacultatif

Réponses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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.

Connectors