{"openapi":"3.1.0","info":{"title":"Synthesia (BYOK) API","version":"0.1.0","description":"Synthesia (BYOK) lets an AI assistant read your own Synthesia data through the Synthesia API with a key you supply (Synthesia API key (Legacy v2 scope)). Read-only: 5 tools (list_videos, get_video, list_templates, get_template, get_credit_balance). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-synthesia.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-synthesia/docs"},"termsOfService":"https://connectorbay.com/byok-synthesia/terms"},"servers":[{"url":"https://byok-synthesia.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-synthesia/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_videos":{"post":{"operationId":"list_videos","summary":"List videos created through the API or in Studio, with render status, duration, visibility and download link when comple","description":"List videos created through the API or in Studio, with render status, duration, visibility and download link when complete. Use for \"Which Synthesia videos are still rendering\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return; use the nextOffset of the previous answer to page.","title":"Offset"},"source":{"anyOf":[{"enum":["workspace","shared_with_me","my_videos"],"type":"string"},{"type":"null"}],"default":null,"description":"Which videos: workspace, shared_with_me or my_videos (one value).","title":"Source"}},"title":"list_videosArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_video":{"post":{"operationId":"get_video","summary":"Get one video by id with status (in_progress, complete, error, ...), duration and download link when ready. Use for \"Is ","description":"Get one video by id with status (in_progress, complete, error, ...), duration and download link when ready. Use for \"Is Synthesia video 5d8f3c done rendering\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"video_id":{"description":"Video id from list_videos.","maxLength":200,"title":"Video Id","type":"string"},"include_rejected":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to return a video that content moderation rejected with status rejected instead of an error.","title":"Include Rejected"}},"required":["video_id"],"title":"get_videoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_templates":{"post":{"operationId":"list_templates","summary":"List Studio templates (Synthesia's own and your workspace's) with ids, visibility and duration. Use for \"Which Synthesia","description":"List Studio templates (Synthesia's own and your workspace's) with ids, visibility and duration. Use for \"Which Synthesia templates can I use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return; use the nextOffset of the previous answer to page.","title":"Offset"},"source":{"anyOf":[{"enum":["synthesia","workspace","shared_with_me"],"type":"string"},{"type":"null"}],"default":null,"description":"Which templates: synthesia, workspace or shared_with_me (one value).","title":"Source"}},"title":"list_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_template":{"post":{"operationId":"get_template","summary":"Get one template by id including the variables you can fill when creating a video from it. Use for \"Which variables does","description":"Get one template by id including the variables you can fill when creating a video from it. Use for \"Which variables does Synthesia template tmpl_123 take\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"template_id":{"description":"Template id from list_templates.","maxLength":200,"title":"Template Id","type":"string"}},"required":["template_id"],"title":"get_templateArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_credit_balance":{"post":{"operationId":"get_credit_balance","summary":"Show the workspace's current billing period and its credit balance (total, consumed, available). Use for \"How many Synth","description":"Show the workspace's current billing period and its credit balance (total, consumed, available). Use for \"How many Synthesia credits do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_credit_balanceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}