Create a draft app connection from gallery input

POST/api/companies/{companyId}/tools/apps/connect
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

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.

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

workspaceServicesobjectOptional
workspaceServices.gmailstringOptionalone of: "read", "write"
workspaceServices.drivestringOptionalone of: "read", "write"
workspaceServices.calendarstringOptionalone of: "read", "write"
agentInstructionsobject | nullOptional
agentInstructions.enabledbooleanRequired
agentInstructions.textstringRequired1–2000 characters
agentInstructions.templateobjectOptional
agentInstructions.template.idstringRequired1–160 characters
agentInstructions.template.versionintegerRequired> 0
galleryKeystringOptional1–120 characters
connectionMethodKeystringOptional1–120 characters
linkstring (uri)Optionalat most 2000 characters
namestringOptional1–160 characters
credentialValuesobject<string, string>Optional
configValuesobjectOptional
applicationIdstring (uuid)Optional
interactionIdstring (uuid)Optional
resumeConnectionIdstring (uuid)Optional
reconnectConnectionIdstring (uuid)Optional
saveDraftbooleanOptional
authModestringOptionalone of: "auto", "none", "bearer", "custom_headers", "oauth"
oauthClientobjectOptional
oauthClient.clientIdstringRequired1–4096 characters
oauthClient.clientSecretstringOptional1–16384 characters
credentialSourcestringOptionalone of: "veyra_vault", "vercel_connect"
vercelConnectobjectOptional
vercelConnect.connectorstringRequired1–255 characters
grantKindstringOptionalone of: "organization", "user", "agent"
subjectAgentIdstring (uuid)Optional

Responses

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

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

Connectors