Create a chat endpoint

POST/api/companies/{companyId}/chat-endpoints
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Create a chat endpoint.

Creates one provider bot endpoint bound permanently to one Veyra Intelligence agent. Provider setup and verification happen in later calls. Chat providers need Chat connectors, and GitHub needs GitHub review bots, turned on by an instance admin in Experimental settings at //company/settings/instance/experimental. While that setting is off, connections_search shows the provider as unavailable and this call is refused; agents cannot change it. Link that page as Experimental settings and reply.

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

companyIdstring (uuid)RequiredThe organization's id.

Request body

application/json · required

providerstringRequiredone of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "imessage-photon"
assignedAgentIdstring (uuid)Required
applicationIdstring (uuid)Optional
namestringOptional1–160 characters
slackAppobjectOptional
slackApp.appNamestringRequired1–35 characters
slackApp.botNamestringRequired1–80 characterspattern: ^[a-z0-9._-]+$
slackApp.commandstringRequired2–32 characterspattern: ^\/[a-z0-9_-]+$
slackSetupMethodstringOptionalone of: "managed", "automatic", "manual", "existing"

Responses

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.

Chat channels