Справочник API публикуется на английском языке.

Create a named MCP gateway

POST/api/companies/{companyId}/tools/gateways
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

namestringОбязательный1–160 characters
slugstringНеобязательный1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
displaySlugstringНеобязательный1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
descriptionstring | nullНеобязательныйat most 4000 characters
profileIdstring (uuid)Обязательный
defaultProfileModestringНеобязательныйone of: "gateway_only", "inherit_context_then_gateway", "gateway_then_context"
contextScopeTypestringНеобязательныйone of: "none", "company", "project", "routine", "issue", "agent"
contextScopeIdstring | nullНеобязательный1–200 characters
agentIdstring (uuid) | nullНеобязательный
projectIdstring (uuid) | nullНеобязательный
issueIdstring (uuid) | nullНеобязательный
approvalIssueIdstring (uuid) | nullНеобязательный
authConfigobjectНеобязательный
authConfig.versionnumberНеобязательныйone of: 1
authConfig.beareranyОбязательный
authConfig.oauthanyОбязательный
headerPolicyobjectНеобязательный
headerPolicy.versionnumberНеобязательныйone of: 1
headerPolicy.callerPassthroughanyОбязательный
headerPolicy.staticHeadersarray<object>Необязательный
headerPolicy.staticHeaders[].namestringОбязательный1–120 characterspattern: ^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$
headerPolicy.staticHeaders[].valueRefstring | nullНеобязательныйat most 240 characters
headerPolicy.staticHeaders[].valuestring | nullНеобязательныйat most 4000 characters
headerPolicy.generatedMetadataanyОбязательный
headerPolicy.responseHeadersanyОбязательный
metadataPolicyobjectНеобязательный
metadataPolicy.versionnumberНеобязательныйone of: 1
metadataPolicy.forwardCompanyIdbooleanНеобязательный
metadataPolicy.forwardGatewayIdbooleanНеобязательный
metadataPolicy.forwardProjectIdbooleanНеобязательный
metadataPolicy.forwardIssueIdbooleanНеобязательный
metadataPolicy.forwardAgentIdbooleanНеобязательный
metadataPolicy.forwardRunIdbooleanНеобязательный
metadataPolicy.forwardCorrelationIdbooleanНеобязательный
onDemandToolsConfigobjectНеобязательный
onDemandToolsConfig.enabledbooleanНеобязательный
onDemandToolsConfig.searchToolNamestringНеобязательныйone of: "search_tools"
onDemandToolsConfig.runToolNamestringНеобязательныйone of: "run_tool"
metadataobject | nullНеобязательный

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

MCP gateway