menu-open

Nexvio API

The Nexvio REST API lets you programmatically manage every aspect of your AI-powered customer service platform β€” bots, conversations, knowledge sources, and third-party integrations. All requests use HTTPS and return JSON.

Base URL

https://api.nexvio.ai/v1

Authentication

All API requests require a bearer token. Generate an API key from your Nexvio dashboard under Settings → API Keys, then pass it in every request:

Authorization: Bearer <YOUR_API_KEY>

Keep your API key private. Rotate it immediately from the dashboard if it is ever exposed.

Core resources

Bots

Create and configure AI chatbot agents. Set the system prompt, choose the underlying model, attach knowledge sources, and control deployment channels.

MethodPathDescription
GET/botsList all bots
POST/botsCreate a bot
GET/bots/:idRetrieve a bot
PATCH/bots/:idUpdate a bot
DELETE/bots/:idDelete a bot

Conversations

Access full conversation history, individual messages, and metadata for every chat session handled by your bots.

MethodPathDescription
GET/conversationsList conversations
GET/conversations/:idRetrieve a conversation
GET/conversations/:id/messagesList messages in a conversation

Knowledge sources

Upload documents, sync URLs, or connect data integrations that your bots use to answer questions accurately.

MethodPathDescription
GET/knowledgeList knowledge sources
POST/knowledgeAdd a knowledge source
DELETE/knowledge/:idRemove a knowledge source

Integrations

Connect Nexvio to external platforms (Slack, Zoom, Zapier, and more) and manage those connections programmatically.

MethodPathDescription
GET/integrationsList active integrations
POST/integrationsEnable an integration
DELETE/integrations/:idDisable an integration

Errors

The API uses standard HTTP status codes. Error responses include a JSON body with a message field describing the problem.

StatusMeaning
400Bad request β€” invalid parameters
401Unauthorized β€” missing or invalid API key
403Forbidden β€” insufficient permissions
404Not found
429Rate limit exceeded β€” retry after the indicated delay
500Internal server error

Rate limits

Requests are rate-limited per API key. The current limits are returned in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 1714900800

Getting started

  1. Sign in to your Nexvio dashboard and navigate to Settings → API Keys.
  2. Click Generate new key and copy the token β€” it will only be shown once.
  3. Make your first request:
    curl https://api.nexvio.ai/v1/bots \
      -H "Authorization: Bearer YOUR_API_KEY"
  4. Explore the resource sections above to build your integration.

Support

If you run into issues or have questions about the API, reach out to us at support@nexvio.ai or visit our contact page.