samautomation-work

samautomation-work API

samautomation-work API as documented publicly: 35 operations. Contract generated from the documentation by API Evangelist (2026-10-31); not the provider's own document.

GitHub OpenAPI

Operations 35

GET /api/ai/credits/balance Get subscription / topup credits remaining. #
POST /api/ai/generate Alias of /api/ai/jobs for backward compatibility. #
POST /api/ai/jobs POST /api/ai/jobs #
GET /api/ai/models GET /api/ai/models #
POST /api/ai/topups/checkout/{packageId} POST /api/ai/topups/checkout/{packageId} #
GET /api/ai/topups/packages List available credit topup packages. #
GET /api/ai/veo31/1080p/{jobId} Fetch 1080p upgrade when available. #
POST /api/ai/veo31/extend Extend completed jobs. #
POST /api/ai/veo31/image/generate Image-to-video generation. #
POST /api/ai/veo31/reference Reference-image generation. #
POST /api/ai/veo31/text/generate Text generation. #
GET /api/autocaptions/checkout/{packageId} This path is documented as POST /api/autocaptions/checkout/{package_id}, not GET. #
GET /api/autocaptions/credits GET /api/autocaptions/credits #
GET /api/autocaptions/generate This path is documented as POST /api/autocaptions/generate, not GET. #
POST /api/autocaptions/generate POST /api/autocaptions/generate #
GET /api/autocaptions/pricing GET /api/autocaptions/pricing #
POST /api/autocaptions/process Submit a video for captioning with styled, broadcast-quality subtitles burned into the file. #
GET /api/autocaptions/subscription/status GET /api/autocaptions/subscription/status #
POST /api/function/video-generation/loop-video Create looping videos with background and media files. #
POST /api/function/video-generation/mix-video Direct replacement for the automation job people expect from a CapCut API. #
GET /api/function/video-generation/progress Poll the progress of a video generation task. #
GET /api/function/video-generation/progress/{id} Lets n8n, Make.com and custom apps wait for the finished video. #
POST /api/function/video-generation/simple-video Create a simple video with a single media file. #
GET /api/function/video-generation/tasks List recent tasks. #
GET /api/function/video-generation/usage-summary Summarize usage for a specified number of days. #
DELETE /api/templates Delete a template preset. #
POST /api/templates Create a template preset for reusable render configurations. #
GET /api/templates/list List your templates and public templates. #
POST /api/video-packs/webhook Stripe webhook for payment processing. #
POST /api/video-packs/{packId}/buy Buy a video pack. #
GET /music.mp3 GET /music.mp3 #
POST /render/advanced-video Structured output settings, main clips, backgrounds, audio mixing, preview mode and template merging for full control. #
POST /video-generation/loop-video Loop media to a target duration over a background track — great for ambient, music or always-on screens. #
POST /video-generation/mix-video Compose a media_list of clips and images with voice-over, background music and timed captions into one MP4. #
POST /video-generation/simple-video The fastest path: a list of video / image items, validated settings, an MP4 out. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/samautomation-work/openapi/_ae-authored/samautomation-work-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-api-ai-generate-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-api-autocaptions-process-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-video-generation-loop-video-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-api-function-video-generation-simple-video-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-render-advanced-video-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/samautomation-work/json-schema/samautomation-work-post-video-generation-mix-video-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/samautomation-work:samautomation-work-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

samautomation-work-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: samautomation-work API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 35 operation(s) read from 35 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; samautomation-work has published no machine-readable
    contract that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 13
    documentation: 22
    pages-with-code: 6
    pages-read: 35
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-31'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://samautomation.work/api/ai/docs
  - https://samautomation.work/api/autocaptions/docs
  - https://samautomation.work/capcut-api
  - https://samautomation.work/ai-video-api
  - https://samautomation.work/docs
  - https://samautomation.work/api/autocaptions/docs.json
  - https://samautomation.work/json-to-video
  - https://samautomation.work/autocaptions
  - https://samautomation.work/features
  - https://samautomation.work/text-to-video
  - https://samautomation.work/create-video-from-photos
  - https://samautomation.work/ai-video-dubbing
  - https://samautomation.work/talking-avatar
  - https://samautomation.work/models/grok-imagine-video
  - https://samautomation.work/models/vidu-q4-i2v
  - https://samautomation.work/models/vidu-q4-r2v
  - https://samautomation.work/models/hailuo-2-3-standard
  - https://samautomation.work/models/wan-2-7-i2v
  - https://samautomation.work/models/wan-2-7-r2v
  - https://samautomation.work/models/wan-2-6-flash-v2v
  - https://samautomation.work/models/wan-2-6-flash-i2v
  - https://samautomation.work/models/flux-3-klein
  - https://samautomation.work/models/h3-lite-t2v
  - https://samautomation.work/models/h3-lite-r2v
  - https://samautomation.work/models/h3-lite-i2v
  - https://samautomation.work/models/seedream-v5-flash
  - https://samautomation.work/models/z-image
  - https://samautomation.work/models/nano-banana
  - https://samautomation.work/models/special-video-elevenlabs-template-baby
  - https://samautomation.work/models/nano-banana-2-lite
  - https://samautomation.work/models/qwen-image
  - https://samautomation.work/models/grok-imagine-2
  - https://samautomation.work/models/qwen-image-3
  - https://samautomation.work/models/wan-2-7-image
  - https://samautomation.work/models/pixverse-v6-t2v
paths:
  /api/ai/credits/balance:
    get:
      operationId: get_api_ai_credits_balance
      tags:
      - Api
      summary: Get subscription / topup credits remaining.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAiCreditsBalanceResponse'
      x-evidence:
        kind: documentation
  /api/ai/generate:
    post:
      operationId: post_api_ai_generate
      tags:
      - Api
      summary: Alias of /api/ai/jobs for backward compatibility.
      x-source: https://samautomation.work/api/ai/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAiGenerateRequest'
      responses:
        '202':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAiGenerateResponse'
      x-evidence:
        kind: documentation
  /api/ai/jobs:
    post:
      operationId: post_api_ai_jobs
      tags:
      - Api
      summary: POST /api/ai/jobs
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://samautomation.work/api/ai/jobs\" \\    -H \"X-API-Key: YOUR_SAMAUTOMATION_API_KEY\" \\    -H \"Content-Type:\
          \ application/json\" \\    -d '{      \"model_id\" : \"wan-2-7-t2v\" ,      \"prompt\" : \"A neon koi swimming through a rainy Tokyo\
          \ alley at night\" ,      \"options\" : { \"resolution\" : \"1080p\" , \"duration_s\" : 10 , \"aspect_ratio\" : \"16:9\" }    }' \n\
          \ 3. Image-to-video — pass a reference "
  /api/ai/models:
    get:
      operationId: get_api_ai_models
      tags:
      - Api
      summary: GET /api/ai/models
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://samautomation.work/api/ai/models\" \\    -H \"X-API-Key: YOUR_SAMAUTOMATION_API_KEY\" \n White-label by\
          \ default. Your users only ever send SamAutomation keys — provider access is brokered server-side, so no upstream credentials are exposed\
          \ to integrators. "
  /api/ai/topups/checkout/{packageId}:
    post:
      operationId: post_api_ai_topups_checkout_packageId
      tags:
      - Api
      summary: POST /api/ai/topups/checkout/{packageId}
      x-source: https://samautomation.work/api/ai/docs
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ai/topups/packages:
    get:
      operationId: get_api_ai_topups_packages
      tags:
      - Api
      summary: List available credit topup packages.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAiTopupsPackagesResponse'
      x-evidence:
        kind: documentation
  /api/ai/veo31/1080p/{jobId}:
    get:
      operationId: get_api_ai_veo31_1080p_jobId
      tags:
      - Api
      summary: Fetch 1080p upgrade when available.
      x-source: https://samautomation.work/api/ai/docs
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: index
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ai/veo31/extend:
    post:
      operationId: post_api_ai_veo31_extend
      tags:
      - Api
      summary: Extend completed jobs.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ai/veo31/image/generate:
    post:
      operationId: post_api_ai_veo31_image_generate
      tags:
      - Api
      summary: Image-to-video generation.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ai/veo31/reference:
    post:
      operationId: post_api_ai_veo31_reference
      tags:
      - Api
      summary: Reference-image generation.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ai/veo31/text/generate:
    post:
      operationId: post_api_ai_veo31_text_generate
      tags:
      - Api
      summary: Text generation.
      x-source: https://samautomation.work/api/ai/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/autocaptions/checkout/{packageId}:
    get:
      operationId: get_api_autocaptions_checkout_packageId
      tags:
      - Api
      summary: This path is documented as POST /api/autocaptions/checkout/{package_id}, not GET.
      x-source: https://samautomation.work/api/autocaptions/docs.json
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/autocaptions/credits:
    get:
      operationId: get_api_autocaptions_credits
      tags:
      - Api
      summary: GET /api/autocaptions/credits
      x-source: https://samautomation.work/api/autocaptions/docs
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAutocaptionsCreditsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"X-API-Key: your-api-key-here\"  \"https://samautomation.work/api/autocaptions/credits\" \n \U0001F4A1 Getting your\
          \ API key \n Log in to your SamAutomation dashboard to generate an API key. "
  /api/autocaptions/generate:
    get:
      operationId: get_api_autocaptions_generate
      tags:
      - Api
      summary: This path is documented as POST /api/autocaptions/generate, not GET.
      x-source: https://samautomation.work/api/autocaptions/docs.json
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_autocaptions_generate
      tags:
      - Api
      summary: POST /api/autocaptions/generate
      x-source: https://samautomation.work/api/autocaptions/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAutocaptionsGenerateRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAutocaptionsGenerateResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://samautomation.work/api/autocaptions/generate\"  -H \"X-API-Key: YOUR_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{\n \"video_url\": \"https://example.com/video.mp4\",\n \"caption_type\": \"standard\"\n }' \n 3. Check status \n Copy "
  /api/autocaptions/pricing:
    get:
      operationId: get_api_autocaptions_pricing
      tags:
      - Api
      summary: GET /api/autocaptions/pricing
      x-source: https://samautomation.work/api/autocaptions/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X GET "https://samautomation.work/api/autocaptions/pricing" '
  /api/autocaptions/process:
    post:
      operationId: post_api_autocaptions_process
      tags:
      - Api
      summary: Submit a video for captioning with styled, broadcast-quality subtitles burned into the file.
      x-source: https://samautomation.work/autocaptions
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
        description: API key for authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAutocaptionsProcessRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAutocaptionsProcessResponse'
      x-evidence:
        kind: documentation
  /api/autocaptions/subscription/status:
    get:
      operationId: get_api_autocaptions_subscription_status
      tags:
      - Api
      summary: GET /api/autocaptions/subscription/status
      x-source: https://samautomation.work/api/autocaptions/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X GET "https://samautomation.work/api/autocaptions/subscription/status"  -H "X-API-Key: YOUR_API_KEY" '
  /api/function/video-generation/loop-video:
    post:
      operationId: post_api_function_video_generation_loop_video
      tags:
      - Api
      summary: Create looping videos with background and media files.
      x-source: https://samautomation.work/docs
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiFunctionVideoGenerationLoopVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiFunctionVideoGenerationLoopVideoResponse'
      x-evidence:
        kind: documentation
  /api/function/video-generation/mix-video:
    post:
      operationId: post_api_function_video_generation_mix_video
      tags:
      - Api
      summary: Direct replacement for the automation job people expect from a CapCut API.
      x-source: https://samautomation.work/capcut-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/function/video-generation/progress:
    get:
      operationId: get_api_function_video_generation_progress
      tags:
      - Api
      summary: Poll the progress of a video generation task.
      x-source: https://samautomation.work/json-to-video
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFunctionVideoGenerationProgressResponse'
      x-evidence:
        kind: documentation
  /api/function/video-generation/progress/{id}:
    get:
      operationId: get_api_function_video_generation_progress_id
      tags:
      - Api
      summary: Lets n8n, Make.com and custom apps wait for the finished video.
      x-source: https://samautomation.work/capcut-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/function/video-generation/simple-video:
    post:
      operationId: post_api_function_video_generation_simple_video
      tags:
      - Api
      summary: Create a simple video with a single media file.
      x-source: https://samautomation.work/docs
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiFunctionVideoGenerationSimpleVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiFunctionVideoGenerationSimpleVideoResponse'
      x-evidence:
        kind: documentation
  /api/function/video-generation/tasks:
    get:
      operationId: get_api_function_video_generation_tasks
      tags:
      - Api
      summary: List recent tasks.
      x-source: https://samautomation.work/docs
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/function/video-generation/usage-summary:
    get:
      operationId: get_api_function_video_generation_usage_summary
      tags:
      - Api
      summary: Summarize usage for a specified number of days.
      x-source: https://samautomation.work/docs
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
      - name: days
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/templates:
    delete:
      operationId: delete_api_templates
      tags:
      - Api
      summary: Delete a template preset.
      x-source: https://samautomation.work/json-to-video
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Template ID to delete
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiTemplatesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_templates
      tags:
      - Api
      summary: Create a template preset for reusable render configurations.
      x-source: https://samautomation.work/json-to-video
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiTemplatesRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiTemplatesResponse'
      x-evidence:
        kind: documentation
  /api/templates/list:
    get:
      operationId: get_api_templates_list
      tags:
      - Api
      summary: List your templates and public templates.
      x-source: https://samautomation.work/json-to-video
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiTemplatesListResponse'
      x-evidence:
        kind: documentation
  /api/video-packs/webhook:
    post:
      operationId: post_api_video_packs_webhook
      tags:
      - Api
      summary: Stripe webhook for payment processing.
      x-source: https://samautomation.work/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/video-packs/{packId}/buy:
    post:
      operationId: post_api_video_packs_packId_buy
      tags:
      - Api
      summary: Buy a video pack.
      x-source: https://samautomation.work/docs
      parameters:
      - name: packId
        in: path
        required: true
        schema:
          type: string
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /music.mp3:
    get:
      operationId: get_music_mp3
      tags:
      - Music
      summary: GET /music.mp3
      x-source: https://samautomation.work/capcut-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl, that's what a JSON video API is for: grab a SamAutomation API key and render your first MP4 from a JSON payload. \n CapCut\
          \ API Pricing vs CapCut Pro \n CapCut Pro pricing is for the editor: a subscription that unlocks premium effects, assets and exports\
          \ inside the app. It is not API pricing — there is no public price list for calling CapCut from code, because there is no public rendering\
          \ API t"
  /render/advanced-video:
    post:
      operationId: post_render_advanced_video
      tags:
      - Render
      summary: Structured output settings, main clips, backgrounds, audio mixing, preview mode and template merging for full control.
      x-source: https://samautomation.work/json-to-video
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRenderAdvancedVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRenderAdvancedVideoResponse'
      x-evidence:
        kind: documentation
  /video-generation/loop-video:
    post:
      operationId: post_video_generation_loop_video
      tags:
      - Video Generation
      summary: Loop media to a target duration over a background track — great for ambient, music or always-on screens.
      x-source: https://samautomation.work/json-to-video
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVideoGenerationLoopVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVideoGenerationLoopVideoResponse'
      x-evidence:
        kind: documentation
  /video-generation/mix-video:
    post:
      operationId: post_video_generation_mix_video
      tags:
      - Video Generation
      summary: Compose a media_list of clips and images with voice-over, background music and timed captions into one MP4.
      x-source: https://samautomation.work/json-to-video
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVideoGenerationMixVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVideoGenerationMixVideoResponse'
      x-evidence:
        kind: documentation
  /video-generation/simple-video:
    post:
      operationId: post_video_generation_simple_video
      tags:
      - Video Generation
      summary: 'The fastest path: a list of video / image items, validated settings, an MP4 out.'
      x-source: https://samautomation.work/json-to-video
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVideoGenerationSimpleVideoRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVideoGenerationSimpleVideoResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiAiCreditsBalanceResponse:
      type: object
      properties:
        success:
          type: boolean
        subscription_credits_remaining:
          type: integer
        topup_credits_remaining:
          type: integer
        total_credits_remaining:
          type: integer
        reset_date:
          type: string
    PostApiAiGenerateRequest:
      type: object
      properties:
        model_id:
          type: string
          description: Must match an active catalog ID from /api/ai/models.
        prompt:
          type: string
          description: Sanitized server-side (max 2000 chars in the unified flow).
        image_urls:
          type: string
          description: Reference image(s) for image-to-video (i2v) and image models.
        video_urls:
          type: string
          description: Source video for editing, video-to-video and lip-sync models.
        audio_urls:
          type: string
          description: Target speech/voice audio for lip-sync and avatar models.
        options:
          type: string
          description: Per-model params — see options reference below.
        input:
          type: string
          description: Raw provider payload passthrough.
      required:
      - model_id
    PostApiAiGenerateResponse:
      type: object
      properties:
        success:
          type: boolean
        job_id:
          type: integer
        status:
          type: string
        credits_charged:
          type: integer
        credits_remaining:
          type: integer
    GetApiAiTopupsPackagesResponse:
      type: object
      properties:
        success:
          type: boolean
        packages:
          type: array
    GetApiAutocaptionsCreditsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        task_id:
          type: string
        status_url:
          type: string
        caption_type:
          type: string
        caption_service:
          type: string
        credits_remaining:
          type: integer
    PostApiAutocaptionsGenerateRequest:
      type: object
      properties:
        video_url:
          type: string
        caption_type:
          type: string
    PostApiAutocaptionsGenerateResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        task_id:
          type: string
        status_url:
          type: string
        caption_type:
          type: string
        caption_service:
          type: string
        credits_remaining:
          type: integer
    PostApiAutocaptionsProcessRequest:
      type: object
      properties:
        video_url:
          type: string
          description: URL of the video to caption
        font:
          type: string
          description: Caption font (one of 9 available fonts)
        color:
          type: string
          description: Caption text color in hex format
        position:
          type: string
          description: 'Caption position: top, middle, or bottom'
        language:
          type: string
          description: Language code for transcription (25+ languages supported)
      required:
      - video_url
    PostApiAutocaptionsProcessResponse:
      type: object
      properties:
        status:
          type: string
          description: Processing status of the caption request
        video_url:
          type: string
          description: URL to the captioned output video
    PostApiFunctionVideoGenerationLoopVideoRequest:
      type: object
      properties:
        type:
          type: string
          description: Must be LoopVideo
        data:
          type: object
          description: Container for loop-video payload fields
      required:
      - type
      - data
    PostApiFunctionVideoGenerationLoopVideoResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
    GetApiFunctionVideoGenerationProgressResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
        status:
          type: string
          description: Task status such as completed or failed
        output_url:
          type: string
          description: URL to the rendered MP4 file
    PostApiFunctionVideoGenerationSimpleVideoRequest:
      type: object
      properties:
        media_list:
          type: array
          description: Array with one or more media objects. Each item must include type and url.
        settings:
          type: object
          description: Video settings such as aspect_ratio, quality, etc.
      required:
      - media_list
    PostApiFunctionVideoGenerationSimpleVideoResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
    DeleteApiTemplatesResponse:
      type: object
      properties:
        success:
          type: boolean
    PostApiTemplatesRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
    PostApiTemplatesResponse:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
    GetApiTemplatesListResponse:
      type: object
      properties:
        data:
          type: array
          description: List of template objects
    PostRenderAdvancedVideoRequest:
      type: object
      properties:
        clips:
          type: array
          description: Structured clip model
        captions:
          type: array
          description: Structured caption model
        backgrounds:
          type: array
        audio_mixing:
          type: object
        preview_mode:
          type: boolean
    PostRenderAdvancedVideoResponse:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
    PostVideoGenerationLoopVideoRequest:
      type: object
      properties:
        type:
          type: string
          description: Must be LoopVideo
        media_list:
          type: array
          description: Media items to loop
        background_url:
          type: string
          description: Background track URL
        duration:
          type: number
          description: Optional target duration
        settings:
          type: object
        exports:
          type: object
      required:
      - type
      - media_list
      - background_url
    PostVideoGenerationLoopVideoResponse:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
        data.progress_url:
          type: string
    PostVideoGenerationMixVideoRequest:
      type: object
      properties:
        media_list:
          type: array
          description: Non-empty list of media items
        voice_url:
          type: string
        background_url:
          type: string
        transcripts:
          type: array
        settings:
          type: object
      required:
      - media_list
    PostVideoGenerationMixVideoResponse:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
        data.progress_url:
          type: string
    PostVideoGenerationSimpleVideoRequest:
      type: object
      properties:
        media_list:
          type: array
          description: Per item type + url
        settings:
          type: object
          description: Validated settings with strict enum/range validation
      required:
      - media_list
    PostVideoGenerationSimpleVideoResponse:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
        data.progress_url:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Music
- name: Render
- name: Video Generation