Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Authentication

All requests to the Vakyam API are authenticated with an API key passed as a Bearer token in the Authorization header.
Authorization: Bearer vak_live_<key>
Your API key grants full access to your account's synthesis and credits. Keep it secret, never commit it to source control, and prefer loading it from an environment variable such as VAKYAM_API_KEY.

Get your API key

Create and manage API keys from the Vakyam dashboard . A key is shown only once at creation, so copy it somewhere safe.

Sending the key

from vakyamai import VakyamAI # Reads VAKYAM_API_KEY from the environment client = VakyamAI() # ...or pass it explicitly client = VakyamAI(api_key="vak_live_...")

Failed authentication

A missing, malformed, or revoked key returns 401 Unauthorized:
{ "error": { "status_code": 401, "code": "invalid_api_key", "message": "The API key provided is invalid or has been revoked." } }

WebSocket authentication

The realtime WebSocket endpoint authenticates the same way — pass the Authorization header on connect. A bad key closes the connection with code 4001. See the realtime guide for details.