Splice Agent API & Keys

Updated today

Splice Agent API & Keys

Splice provides an Agent API so external tools, AI agents, and frameworks like ReelKit can generate content programmatically.

Getting an Agent Key

  1. Open Splice and go to your Dashboard
  2. Navigate to Settings or Agent API Keys
  3. Click Create New Key
  4. Give it a name (e.g. "My ReelKit Agent")
  5. Optionally set a default production for the key
  6. Save the key immediately — it is only shown once

Your key looks like: sk_ followed by a long string.

Using the Key

Include your key in every request:

  • Header: Authorization: Bearer sk_...
  • Or: x-api-key: sk_...

What the Agent API Can Do

Session

Get your default production to work with.

Generate Content

  • Image — Text-to-image with model selection and aspect ratios
  • Video — Text-to-video or image-to-video with duration and keyframes
  • Voice — Text-to-speech with voice model selection
  • Music — Generate original music from text descriptions
  • SFX — Sound effects from text
  • Lipsync — Sync character mouth movements to audio
  • Captions — Burn subtitles into video
  • Character/Location/Prop Sheets — Generate reference documentation

Edit Content

  • Image Edit — Modify images with AI
  • Image Upscale — Increase resolution (2x, 4x, 6x)
  • Color Grade — Apply LUT colour grading
  • Media Merge — Combine multiple videos
  • Caption Burn — Add permanent subtitles

Manage Assets

  • List production items (your generated content)
  • Get item status and media URL
  • Check credit balance
  • Transfer credits to/from productions

How It Works

  1. Create a key from the Splice dashboard
  2. Call the API — e.g. POST to generate an image
  3. Get a production_item_id back immediately
  4. Poll for completion — GET the item to check status
  5. Get the media URL when status is "ready"

Polling for Results

Generations are asynchronous. After submitting a generation request:

  1. You receive a production_item_id
  2. Poll GET /api/agents/productions/{id}/items/{itemId}
  3. Check the status field: "pending", "ready", or "failed"
  4. When "ready", the media_url field contains your output

Default Production

Each key can have a default production. If you do not specify a production_id in your requests, the key default is used. Set this when creating the key, or call GET /api/agents/session to get/create one.

Audit Logging

Every Agent API call is logged with:

  • Method and path
  • Status code
  • Timestamp
  • Associated production

This helps you track usage and debug issues.

Documentation

The full Agent API spec is available at splice.film.fun/llms.txt — this is designed for AI agents and LLMs to understand the complete API.

Swagger/OpenAPI documentation is also available at splice.film.fun/api-docs.