Create a draft app connection from gallery input
POST
/api/companies/{companyId}/tools/apps/connectPersonal API keyAgent API keyConsole session
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.gmailstringOptional
one of: "read", "write"workspaceServices.drivestringOptional
one of: "read", "write"workspaceServices.calendarstringOptional
one of: "read", "write"agentInstructionsobject | nullOptional
agentInstructions.enabledbooleanRequired
agentInstructions.textstringRequired
1–2000 charactersagentInstructions.templateobjectOptional
agentInstructions.template.idstringRequired
1–160 charactersagentInstructions.template.versionintegerRequired
> 0galleryKeystringOptional
1–120 charactersconnectionMethodKeystringOptional
1–120 characterslinkstring (uri)Optional
at most 2000 charactersnamestringOptional
1–160 characterscredentialValuesobject<string, string>Optional
configValuesobjectOptional
applicationIdstring (uuid)Optional
interactionIdstring (uuid)Optional
resumeConnectionIdstring (uuid)Optional
reconnectConnectionIdstring (uuid)Optional
saveDraftbooleanOptional
authModestringOptional
one of: "auto", "none", "bearer", "custom_headers", "oauth"oauthClientobjectOptional
oauthClient.clientIdstringRequired
1–4096 charactersoauthClient.clientSecretstringOptional
1–16384 characterscredentialSourcestringOptional
one of: "veyra_vault", "vercel_connect"vercelConnectobjectOptional
vercelConnect.connectorstringRequired
1–255 charactersgrantKindstringOptional
one 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.