Products overview

Every Open API product creates a task with a taskId. You can list, inspect, and delete tasks through shared task endpoints regardless of product type.

​

Separate from website tasks

Open API tasks are not the same as jobs you start on vmeg.ai — same rule as API assets.

• Use /openapi/v1/tasks/** and webhooks to track API work only.
• Website task history does not list API jobs, and website jobs cannot be queried through the Open API.

​

Task APIs

Request and response fields: List tasks, Get task detail, and Delete task. Task list, detail, and delete, plus asset list and cloned-voice queries, are scoped to your API Key. Open API requests do not include a separate project identifier.

​

Sync vs async

​

Async integration checklist

1. API Key
2. Idempotency — X-Idempotency-Key on every POST
3. Webhooks — webhook URL on API Configuration; copy the generated secret; return 2xx quickly
4. Submit create-async → save taskId
5. Handle the Webhook request body — check event (openapi-tts, openapi-translate, etc.) then parse data

​

Sync integration

Call create (non-async) with X-Idempotency-Key and read results from the HTTP data payload.

​

Task types

taskType uses short codes:

​

Product guides