API referansı İngilizce yayımlanır.

Create a draft app connection from gallery input

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

Create a draft app connection from gallery input.

When a person's own MCP server needs an API key, the person adds it themselves on Connect your own MCP server: they enter its URL and type the key into that page's secure field. An agent cannot enter the key and must not ask for it in chat. Link that page and reply instead of creating the connection here.

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

workspaceServicesobjectİsteğe bağlı
workspaceServices.gmailstringİsteğe bağlıone of: "read", "write"
workspaceServices.drivestringİsteğe bağlıone of: "read", "write"
workspaceServices.calendarstringİsteğe bağlıone of: "read", "write"
agentInstructionsobject | nullİsteğe bağlı
agentInstructions.enabledbooleanZorunlu
agentInstructions.textstringZorunlu1–2000 characters
agentInstructions.templateobjectİsteğe bağlı
agentInstructions.template.idstringZorunlu1–160 characters
agentInstructions.template.versionintegerZorunlu> 0
galleryKeystringİsteğe bağlı1–120 characters
connectionMethodKeystringİsteğe bağlı1–120 characters
linkstring (uri)İsteğe bağlıat most 2000 characters
namestringİsteğe bağlı1–160 characters
credentialValuesobject<string, string>İsteğe bağlı
configValuesobjectİsteğe bağlı
applicationIdstring (uuid)İsteğe bağlı
interactionIdstring (uuid)İsteğe bağlı
resumeConnectionIdstring (uuid)İsteğe bağlı
reconnectConnectionIdstring (uuid)İsteğe bağlı
saveDraftbooleanİsteğe bağlı
authModestringİsteğe bağlıone of: "auto", "none", "bearer", "custom_headers", "oauth"
oauthClientobjectİsteğe bağlı
oauthClient.clientIdstringZorunlu1–4096 characters
oauthClient.clientSecretstringİsteğe bağlı1–16384 characters
credentialSourcestringİsteğe bağlıone of: "veyra_vault", "vercel_connect"
vercelConnectobjectİsteğe bağlı
vercelConnect.connectorstringZorunlu1–255 characters
grantKindstringİsteğe bağlıone of: "organization", "user", "agent"
subjectAgentIdstring (uuid)İsteğe bağlı

Yanıtlar

200SuccessThe request worked; the body holds the result.
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.

Connectors