Skip to content
VIDMOATDocs

Direct a narration draft

POSThttps://api.vidmoat.com/v1/speech/directions
Bearer tokenScope speech.generatepricing.direction credits from capabilitiesTry it in the playground

Submit a recoverable narration drafting request. Returns a job ID; poll the existing generation status endpoint. Success proposes reply, script and speed with applied:false and audioGenerated:false. Review with the person before creating a speech generation. No publishing or consent action is available.

Body#

  • voiceIdstringrequired
    A ready own or published creator voice.
  • briefstringrequired
    Your direction, 1 to 2,000 characters.
  • currentScriptstring
    Optional existing script, up to 8,000 Unicode characters.
  • speednumber
    Current pace, 0.75 to 1.25.
  • expressionnumber
    Optional current delivery intensity, 0 to 1, only when capabilities.settings.expression is present.

Response#

Returns 202.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
409conflictThe idempotency key belongs to different inputs, or the job is not in the required state.
503unavailableInference, private storage, configured pilot billing or the limiter is unavailable. Nothing new is charged before admission.