API referansı İngilizce yayımlanır.

Create a named MCP gateway

POST/api/companies/{companyId}/tools/gateways
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

namestringZorunlu1–160 characters
slugstringİsteğe bağlı1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
displaySlugstringİsteğe bağlı1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
descriptionstring | nullİsteğe bağlıat most 4000 characters
profileIdstring (uuid)Zorunlu
defaultProfileModestringİsteğe bağlıone of: "gateway_only", "inherit_context_then_gateway", "gateway_then_context"
contextScopeTypestringİsteğe bağlıone of: "none", "company", "project", "routine", "issue", "agent"
contextScopeIdstring | nullİsteğe bağlı1–200 characters
agentIdstring (uuid) | nullİsteğe bağlı
projectIdstring (uuid) | nullİsteğe bağlı
issueIdstring (uuid) | nullİsteğe bağlı
approvalIssueIdstring (uuid) | nullİsteğe bağlı
authConfigobjectİsteğe bağlı
authConfig.versionnumberİsteğe bağlıone of: 1
authConfig.beareranyZorunlu
authConfig.oauthanyZorunlu
headerPolicyobjectİsteğe bağlı
headerPolicy.versionnumberİsteğe bağlıone of: 1
headerPolicy.callerPassthroughanyZorunlu
headerPolicy.staticHeadersarray<object>İsteğe bağlı
headerPolicy.staticHeaders[].namestringZorunlu1–120 characterspattern: ^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$
headerPolicy.staticHeaders[].valueRefstring | nullİsteğe bağlıat most 240 characters
headerPolicy.staticHeaders[].valuestring | nullİsteğe bağlıat most 4000 characters
headerPolicy.generatedMetadataanyZorunlu
headerPolicy.responseHeadersanyZorunlu
metadataPolicyobjectİsteğe bağlı
metadataPolicy.versionnumberİsteğe bağlıone of: 1
metadataPolicy.forwardCompanyIdbooleanİsteğe bağlı
metadataPolicy.forwardGatewayIdbooleanİsteğe bağlı
metadataPolicy.forwardProjectIdbooleanİsteğe bağlı
metadataPolicy.forwardIssueIdbooleanİsteğe bağlı
metadataPolicy.forwardAgentIdbooleanİsteğe bağlı
metadataPolicy.forwardRunIdbooleanİsteğe bağlı
metadataPolicy.forwardCorrelationIdbooleanİsteğe bağlı
onDemandToolsConfigobjectİsteğe bağlı
onDemandToolsConfig.enabledbooleanİsteğe bağlı
onDemandToolsConfig.searchToolNamestringİsteğe bağlıone of: "search_tools"
onDemandToolsConfig.runToolNamestringİsteğe bağlıone of: "run_tool"
metadataobject | nullİsteğe bağlı

Yanıtlar

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

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

MCP gateway