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

Create a named MCP gateway

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

Create a named MCP gateway.

Creates a gateway that exposes a tool access profile to external MCP clients. Agents with delegated connection management may create it; agent responses also include gatewayPath (//apps/gateways//overview) and tokensPath (//apps/gateways//tokens). Link the person to them as Markdown links. A client needs a gateway client token to connect; see POST /api/tool-gateway/gateways/{gatewayId}/tokens.

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

namestringObligatoire1–160 characters
slugstringFacultatif1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
displaySlugstringFacultatif1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
descriptionstring | nullFacultatifat most 4000 characters
profileIdstring (uuid)Obligatoire
defaultProfileModestringFacultatifone of: "gateway_only", "inherit_context_then_gateway", "gateway_then_context"
contextScopeTypestringFacultatifone of: "none", "company", "project", "routine", "issue", "agent"
contextScopeIdstring | nullFacultatif1–200 characters
agentIdstring (uuid) | nullFacultatif
projectIdstring (uuid) | nullFacultatif
issueIdstring (uuid) | nullFacultatif
approvalIssueIdstring (uuid) | nullFacultatif
authConfigobjectFacultatif
authConfig.versionnumberFacultatifone of: 1
authConfig.beareranyObligatoire
authConfig.oauthanyObligatoire
headerPolicyobjectFacultatif
headerPolicy.versionnumberFacultatifone of: 1
headerPolicy.callerPassthroughanyObligatoire
headerPolicy.staticHeadersarray<object>Facultatif
headerPolicy.staticHeaders[].namestringObligatoire1–120 characterspattern: ^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$
headerPolicy.staticHeaders[].valueRefstring | nullFacultatifat most 240 characters
headerPolicy.staticHeaders[].valuestring | nullFacultatifat most 4000 characters
headerPolicy.generatedMetadataanyObligatoire
headerPolicy.responseHeadersanyObligatoire
metadataPolicyobjectFacultatif
metadataPolicy.versionnumberFacultatifone of: 1
metadataPolicy.forwardCompanyIdbooleanFacultatif
metadataPolicy.forwardGatewayIdbooleanFacultatif
metadataPolicy.forwardProjectIdbooleanFacultatif
metadataPolicy.forwardIssueIdbooleanFacultatif
metadataPolicy.forwardAgentIdbooleanFacultatif
metadataPolicy.forwardRunIdbooleanFacultatif
metadataPolicy.forwardCorrelationIdbooleanFacultatif
onDemandToolsConfigobjectFacultatif
onDemandToolsConfig.enabledbooleanFacultatif
onDemandToolsConfig.searchToolNamestringFacultatifone of: "search_tools"
onDemandToolsConfig.runToolNamestringFacultatifone of: "run_tool"
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

MCP gateway