Developers
Vyostra AI developer docs
The Vyostra AI API is a REST API that lets your own code read the leads, chatbots, forms and voice agents in your Vyostra AI account. You authenticate with an API key, call HTTPS endpoints under /v1, and get JSON back. These docs cover the API and the script tags that embed each widget.
Get started
- Quickstart: your first API requestCreate a Vyostra AI API key and make your first request to the chatbot and leads API with curl, Node.js or Python, in about five minutes.
- API keys and authenticationHow Vyostra AI API keys work: creating and revoking keys, the Bearer header, the four permission scopes, plan requirements, and how to rotate a key safely.
API reference
- REST API referenceEvery endpoint of the Vyostra AI REST API: leads, chatbots, lead forms and voice agents, with parameters, response fields and example requests.
- Errors and rate limitsEvery error code the Vyostra AI API returns, what each one means and how to fix it, plus the rate limit of 120 requests per minute per key and how to retry.
Guides
- Embed the chatbot, form and voice widgetsAdd the Vyostra AI chatbot, lead form and voice agent to any website: the script tag for each widget, where to paste it, and its options.
- Sync leads to your CRM or databaseCopy every Vyostra AI lead into your own CRM or database with the leads API: pagination, de-duplication, polling, and Node.js and Python code.
- Build an integration with Claude, ChatGPT or CursorA ready-to-paste brief that gives Claude, ChatGPT, Cursor or any AI coding assistant what it needs to write a working Vyostra AI integration.