Create a named MCP gateway

POST/api/companies/{companyId}/tools/gateways
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

namestringRequired1–160 characters
slugstringOptional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
displaySlugstringOptional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
descriptionstring | nullOptionalat most 4000 characters
profileIdstring (uuid)Required
defaultProfileModestringOptionalone of: "gateway_only", "inherit_context_then_gateway", "gateway_then_context"
contextScopeTypestringOptionalone of: "none", "company", "project", "routine", "issue", "agent"
contextScopeIdstring | nullOptional1–200 characters
agentIdstring (uuid) | nullOptional
projectIdstring (uuid) | nullOptional
issueIdstring (uuid) | nullOptional
approvalIssueIdstring (uuid) | nullOptional
authConfigobjectOptional
authConfig.versionnumberOptionalone of: 1
authConfig.beareranyRequired
authConfig.oauthanyRequired
headerPolicyobjectOptional
headerPolicy.versionnumberOptionalone of: 1
headerPolicy.callerPassthroughanyRequired
headerPolicy.staticHeadersarray<object>Optional
headerPolicy.staticHeaders[].namestringRequired1–120 characterspattern: ^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$
headerPolicy.staticHeaders[].valueRefstring | nullOptionalat most 240 characters
headerPolicy.staticHeaders[].valuestring | nullOptionalat most 4000 characters
headerPolicy.generatedMetadataanyRequired
headerPolicy.responseHeadersanyRequired
metadataPolicyobjectOptional
metadataPolicy.versionnumberOptionalone of: 1
metadataPolicy.forwardCompanyIdbooleanOptional
metadataPolicy.forwardGatewayIdbooleanOptional
metadataPolicy.forwardProjectIdbooleanOptional
metadataPolicy.forwardIssueIdbooleanOptional
metadataPolicy.forwardAgentIdbooleanOptional
metadataPolicy.forwardRunIdbooleanOptional
metadataPolicy.forwardCorrelationIdbooleanOptional
onDemandToolsConfigobjectOptional
onDemandToolsConfig.enabledbooleanOptional
onDemandToolsConfig.searchToolNamestringOptionalone of: "search_tools"
onDemandToolsConfig.runToolNamestringOptionalone of: "run_tool"
metadataobject | nullOptional

Responses

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

Errors return {"error": "..."}, often with a code and details. See errors and limits.

MCP gateway