Skip to main content
This section documents the public REST endpoints for the VyomFlow API — the surface built for external/agent callers, authenticated with a scoped API key. Every endpoint returns JSON and uses the same authentication, versioning, and error conventions described here.

​
Base URL

All public paths are prefixed with /api/public/v1. For example, the full URL to list chats is:
The MCP endpoint (/api/mcp) shares this same base URL and auth model — see MCP.

​
Authentication

Every endpoint requires an Authorization header with a scoped API key:
If the key is missing, invalid, expired, or revoked, the API returns 401 UNAUTHORIZED. If the key is valid but lacks a required scope, it returns 403 FORBIDDEN. See the Authentication page for how to create a key, which scopes exist, and how to use the “Try it” panel on this site.

​
Versioning

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

​
Resource groups

Chats

Create and list chat sessions.

Runs

Send messages, stream, and cancel agent runs within a chat.

Waitpoints

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

Credits

Read your current credit balance.

​
Errors and rate limits

All endpoints return the same error envelope and are subject to per-API-key rate limits, reported via X-RateLimit-Limit/X-RateLimit-Remaining/X-RateLimit-Reset and, on a 429, Retry-After. Review those pages before building retry logic.