La referencia de la API se publica en inglés.

Create a named MCP gateway

POST/api/companies/{companyId}/tools/gateways
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

namestringObligatorio1–160 characters
slugstringOpcional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
displaySlugstringOpcional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
descriptionstring | nullOpcionalat most 4000 characters
profileIdstring (uuid)Obligatorio
defaultProfileModestringOpcionalone of: "gateway_only", "inherit_context_then_gateway", "gateway_then_context"
contextScopeTypestringOpcionalone of: "none", "company", "project", "routine", "issue", "agent"
contextScopeIdstring | nullOpcional1–200 characters
agentIdstring (uuid) | nullOpcional
projectIdstring (uuid) | nullOpcional
issueIdstring (uuid) | nullOpcional
approvalIssueIdstring (uuid) | nullOpcional
authConfigobjectOpcional
authConfig.versionnumberOpcionalone of: 1
authConfig.beareranyObligatorio
authConfig.oauthanyObligatorio
headerPolicyobjectOpcional
headerPolicy.versionnumberOpcionalone of: 1
headerPolicy.callerPassthroughanyObligatorio
headerPolicy.staticHeadersarray<object>Opcional
headerPolicy.staticHeaders[].namestringObligatorio1–120 characterspattern: ^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$
headerPolicy.staticHeaders[].valueRefstring | nullOpcionalat most 240 characters
headerPolicy.staticHeaders[].valuestring | nullOpcionalat most 4000 characters
headerPolicy.generatedMetadataanyObligatorio
headerPolicy.responseHeadersanyObligatorio
metadataPolicyobjectOpcional
metadataPolicy.versionnumberOpcionalone of: 1
metadataPolicy.forwardCompanyIdbooleanOpcional
metadataPolicy.forwardGatewayIdbooleanOpcional
metadataPolicy.forwardProjectIdbooleanOpcional
metadataPolicy.forwardIssueIdbooleanOpcional
metadataPolicy.forwardAgentIdbooleanOpcional
metadataPolicy.forwardRunIdbooleanOpcional
metadataPolicy.forwardCorrelationIdbooleanOpcional
onDemandToolsConfigobjectOpcional
onDemandToolsConfig.enabledbooleanOpcional
onDemandToolsConfig.searchToolNamestringOpcionalone of: "search_tools"
onDemandToolsConfig.runToolNamestringOpcionalone of: "run_tool"
metadataobject | nullOpcional

Respuestas

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).

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

MCP gateway