Skip to content

Video provider functions

POST /public/v1/video/function

Calls a helper that a video provider exposes. These exist so you can fill in a customParams value that only the provider knows, the way trigger a channel tool does for social channels.

The clearest example is narration: a provider that reads a script aloud needs a voice id, and this is how you get the list of valid ones before calling generate a video.

Doing this in the app? See AI images and video. Also available as videoFunctionTool (MCP); the CLI has no command for it.

Field Required Description
identifier Yes The video provider, the same value type takes on generate a video: veo3 or image-text-slides.
functionName Yes The helper to call. Only the functions a provider deliberately exposes can be called.
params No Arguments for the helper.

Not every provider exposes any. image-text-slides exposes loadVoices, which returns the narration voices you can pass in its customParams. veo3 exposes none, because a single shot with no narration has nothing to look up.

Terminal window
curl -X POST https://dash.sharek.app/api/public/v1/video/function \
-H "Authorization: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"identifier": "image-text-slides",
"functionName": "loadVoices",
"params": {}
}'

Whatever the helper returns, unwrapped:

[
{ "id": "voice-id", "name": "A voice name" }
]

The shape is the provider’s own, so read it from the provider rather than expecting a common envelope.

Response Meaning
400 Function ... not found on video instance The provider has no such helper, or the named function is not one it exposes for calling. Names are case-sensitive.
500 {"statusCode": 500, "message": "Internal server error"} No video provider by that identifier.
  • Only functions a provider explicitly marks as callable are reachable. Naming another method on the provider returns the same not-found error rather than running it.
  • This operation is not throttled and consumes no video credits. Only generate a video does.