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.

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.
Your API Key scopes Open API tasks and assets only. Work done on the website uses a separate store.

Task APIs

ActionEndpoint
ListGET /openapi/v1/tasks/list
DetailGET /openapi/v1/tasks/detail
DeletePOST /openapi/v1/tasks/delete
Request and response fields: List tasks, Get task detail, and Delete task.

Sync vs async

ProductSync createAsync createHow you get results
Media translationPOST .../media-translation/create-asyncAsync only: Webhook
Text to speechPOST .../tts/createPOST .../tts/create-asyncSync: data.results in HTTP response. Async: Webhook
Voice clonePOST .../clone-voice/createPOST .../clone-voice/create-asyncSync: voiceId in response. Async: Webhook
Text translationPOST .../translate/createPOST .../translate/create-asyncSync: data.items in response. Async: Webhook

Async integration checklist

  1. API Key
  2. IdempotencyX-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:
taskTypeProduct
vt / atMedia translation
ttsText to speech
cloneVoiceVoice clone
textTranslationText translation

Product guides

Media translation

Video/audio localization

Text to speech

Speech synthesis

Voice clone

Clone from sample audio

Text translation

Segment translation