Skip to main content
This section documents all public REST endpoints for the VyomFlow API. Every endpoint returns JSON and uses the same authentication, versioning, and error conventions described here.

​
Base URL

The API base URL is configurable at deployment time. The default is:
All paths are prefixed with /api/v1. For example, the full URL to list chats is:

​
Authentication

Every endpoint requires an Authorization header with a Clerk session token:
If the token is missing or invalid, the API returns 401 UNAUTHORIZED. See the Authentication page for how to obtain and refresh tokens.

​
Versioning

The current API version is v1. All endpoints live under /api/v1. Future versions will be introduced under a new path prefix with a migration window.

​
Resource groups

Chats

Create, list, update, and delete chat sessions.

Runs

Start, cancel, and monitor agent runs within a chat.

Waitpoints

Respond to agent waitpoints that pause a turn for user input.

Attachments

Upload and complete file attachments for messages.

​
Errors and rate limits

All endpoints return the same error envelope and are subject to per-user rate limits. Review those pages before building retry logic.