Справочник API публикуется на английском языке.

Create a draft app connection from gallery input

POST/api/companies/{companyId}/tools/apps/connect
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 4 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

workspaceServicesobjectНеобязательный
workspaceServices.gmailstringНеобязательныйone of: "read", "write"
workspaceServices.drivestringНеобязательныйone of: "read", "write"
workspaceServices.calendarstringНеобязательныйone of: "read", "write"
agentInstructionsobject | nullНеобязательный
agentInstructions.enabledbooleanОбязательный
agentInstructions.textstringОбязательный1–2000 characters
agentInstructions.templateobjectНеобязательный
agentInstructions.template.idstringОбязательный1–160 characters
agentInstructions.template.versionintegerОбязательный> 0
galleryKeystringНеобязательный1–120 characters
connectionMethodKeystringНеобязательный1–120 characters
linkstring (uri)Необязательныйat most 2000 characters
namestringНеобязательный1–160 characters
credentialValuesobject<string, string>Необязательный
configValuesobjectНеобязательный
applicationIdstring (uuid)Необязательный
interactionIdstring (uuid)Необязательный
resumeConnectionIdstring (uuid)Необязательный
reconnectConnectionIdstring (uuid)Необязательный
saveDraftbooleanНеобязательный
authModestringНеобязательныйone of: "auto", "none", "bearer", "custom_headers", "oauth"
oauthClientobjectНеобязательный
oauthClient.clientIdstringОбязательный1–4096 characters
oauthClient.clientSecretstringНеобязательный1–16384 characters
credentialSourcestringНеобязательныйone of: "veyra_vault", "vercel_connect"
vercelConnectobjectНеобязательный
vercelConnect.connectorstringОбязательный1–255 characters
grantKindstringНеобязательныйone of: "organization", "user", "agent"
subjectAgentIdstring (uuid)Необязательный

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Connectors