Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vmeg.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
API Key

All endpoints under /openapi/v1/** require an API Key.

​
Request header

Send your key on every request in the HTTP Authorization header (not in the query string or request body): 
Authorization: Bearer <your_api_key>
Example with curl: 
curl "https://api.vmeg.ai/openapi/v1/tasks/list" \
  -H "Authorization: Bearer YOUR_API_KEY"
Replace YOUR_API_KEY with the key from API Configuration.
Do not expose API Keys in client apps or public repositories. Store keys in environment variables or a secrets manager.

​
Create and rotate keys

Create and rotate keys on API Configuration on vmeg.ai (sidebar API after you sign in). Sign in if needed. The same page is where you set your Webhook URL and view the Webhook Secret VMEG generates for async callbacks.
API Configuration is available on paid plans. See Pricing.

​
Authentication failures

HTTP status 401 with a JSON body such as: 
{
  "code": 401,
  "message": "Invalid or missing API Key",
  "data": null
}
See Error codes for the full code list.