La referencia de la API se publica en inglés.

Create a draft app connection from gallery input

POST/api/companies/{companyId}/tools/apps/connect
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 4 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

workspaceServicesobjectOpcional
workspaceServices.gmailstringOpcionalone of: "read", "write"
workspaceServices.drivestringOpcionalone of: "read", "write"
workspaceServices.calendarstringOpcionalone of: "read", "write"
agentInstructionsobject | nullOpcional
agentInstructions.enabledbooleanObligatorio
agentInstructions.textstringObligatorio1–2000 characters
agentInstructions.templateobjectOpcional
agentInstructions.template.idstringObligatorio1–160 characters
agentInstructions.template.versionintegerObligatorio> 0
galleryKeystringOpcional1–120 characters
connectionMethodKeystringOpcional1–120 characters
linkstring (uri)Opcionalat most 2000 characters
namestringOpcional1–160 characters
credentialValuesobject<string, string>Opcional
configValuesobjectOpcional
applicationIdstring (uuid)Opcional
interactionIdstring (uuid)Opcional
resumeConnectionIdstring (uuid)Opcional
reconnectConnectionIdstring (uuid)Opcional
saveDraftbooleanOpcional
authModestringOpcionalone of: "auto", "none", "bearer", "custom_headers", "oauth"
oauthClientobjectOpcional
oauthClient.clientIdstringObligatorio1–4096 characters
oauthClient.clientSecretstringOpcional1–16384 characters
credentialSourcestringOpcionalone of: "veyra_vault", "vercel_connect"
vercelConnectobjectOpcional
vercelConnect.connectorstringObligatorio1–255 characters
grantKindstringOpcionalone of: "organization", "user", "agent"
subjectAgentIdstring (uuid)Opcional

Respuestas

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

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Connectors