Generate a carousel into the media library asynchronously

curl --request POST \
  --url https://api.scripe.io/v1/media/carousels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "proj_a1b2c3d4e5f6g7h8",
  "topic": "<string>",
  "steer": "<string>",
  "outline": "<string>",
  "templateId": "<string>",
  "wait_for_completion_ms": 12500
}
'

import requests

url = "https://api.scripe.io/v1/media/carousels"

payload = {
    "projectId": "proj_a1b2c3d4e5f6g7h8",
    "topic": "<string>",
    "steer": "<string>",
    "outline": "<string>",
    "templateId": "<string>",
    "wait_for_completion_ms": 12500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'proj_a1b2c3d4e5f6g7h8',
    topic: '<string>',
    steer: '<string>',
    outline: '<string>',
    templateId: '<string>',
    wait_for_completion_ms: 12500
  })
};

fetch('https://api.scripe.io/v1/media/carousels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripe.io/v1/media/carousels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projectId' => 'proj_a1b2c3d4e5f6g7h8',
    'topic' => '<string>',
    'steer' => '<string>',
    'outline' => '<string>',
    'templateId' => '<string>',
    'wait_for_completion_ms' => 12500
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripe.io/v1/media/carousels"

	payload := strings.NewReader("{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripe.io/v1/media/carousels")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripe.io/v1/media/carousels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "job_a1b2c3d4e5f6g7h8",
    "type": "POST_GENERATION",
    "status": "QUEUED",
    "projectId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "progress": {
      "progress": 0.5,
      "updatedAt": "2023-11-07T05:31:56Z",
      "message": "<string>"
    },
    "result": {},
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "attemptCount": 1,
    "estimatedCompletionMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

Media

Generate a carousel into the media library asynchronously

Kick off an AI carousel generation: the model picks a design, storyboards the deck, writes every slide, generates any imagery the design calls for, stamps the project’s brand identity onto it, and the result is rendered to a PDF by the same pipeline the dashboard’s carousel download uses. Returns a Job envelope.

The deck is written in the project’s own voice (its brand context and tone-of-voice language) and published under its own identity — author name, handle, headshot and the workspace’s logo — exactly as a deck generated in the dashboard is. Nothing about the deck differs by which surface asked for it.

On completion the job’s result carries:

mediaId — an img_… asset in the project’s media library (visible in GET /v1/media, source: GENERATED), whose stored document lets the deck be reopened in the editor;
documentKey — the S3 key of the rendered PDF, which you pass straight to PATCH /v1/posts/{postId}/media as { "kind": "document", "document": { "key": "…" } }. That is how a carousel actually reaches LinkedIn;
slideCount — how many slides the planner produced;
imageSlots — { pending, filled, budgetDeclined, failed }, how the deck’s generated-image slots resolved. pending is how many the composed deck asked for; anything not filled shipped with the design’s own stand-in art. Check it when you need to know whether the deck you received is complete — a stand-in is visually indistinguishable from a design that wanted no imagery.

Cost: reserved in two phases against the daily AI-spend cap and reconciled with provider actuals after the job runs, so a deck settles at what it really cost. 45¢ is reserved up front for the three chained model calls (design pick, storyboard, slide copy) and the deck’s first 20¢ of imagery. The deck’s real image-slot count is only known once it has been composed, so each further slot reserves its own cost (5¢ a raster, 11¢ an author cutout) immediately before it is generated. Every reservation is a single atomic conditional update: concurrent calls cannot jointly exceed the cap, and losers receive a 402.

If the cap runs out mid-job the carousel is still delivered — the slots that could not be paid for keep their stand-in art and are counted in imageSlots.budgetDeclined. The cap is never overshot.

Decks typically take two to three minutes, comfortably past the 25 000 ms wait_for_completion_ms ceiling — poll GET /v1/jobs/{jobId} rather than sync-waiting.

Requires the media:write scope.

POST

media

carousels

Generate a carousel into the media library asynchronously

curl --request POST \
  --url https://api.scripe.io/v1/media/carousels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "proj_a1b2c3d4e5f6g7h8",
  "topic": "<string>",
  "steer": "<string>",
  "outline": "<string>",
  "templateId": "<string>",
  "wait_for_completion_ms": 12500
}
'

import requests

url = "https://api.scripe.io/v1/media/carousels"

payload = {
    "projectId": "proj_a1b2c3d4e5f6g7h8",
    "topic": "<string>",
    "steer": "<string>",
    "outline": "<string>",
    "templateId": "<string>",
    "wait_for_completion_ms": 12500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'proj_a1b2c3d4e5f6g7h8',
    topic: '<string>',
    steer: '<string>',
    outline: '<string>',
    templateId: '<string>',
    wait_for_completion_ms: 12500
  })
};

fetch('https://api.scripe.io/v1/media/carousels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripe.io/v1/media/carousels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projectId' => 'proj_a1b2c3d4e5f6g7h8',
    'topic' => '<string>',
    'steer' => '<string>',
    'outline' => '<string>',
    'templateId' => '<string>',
    'wait_for_completion_ms' => 12500
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripe.io/v1/media/carousels"

	payload := strings.NewReader("{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripe.io/v1/media/carousels")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripe.io/v1/media/carousels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectId\": \"proj_a1b2c3d4e5f6g7h8\",\n  \"topic\": \"<string>\",\n  \"steer\": \"<string>\",\n  \"outline\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"wait_for_completion_ms\": 12500\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "job_a1b2c3d4e5f6g7h8",
    "type": "POST_GENERATION",
    "status": "QUEUED",
    "projectId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "progress": {
      "progress": 0.5,
      "updatedAt": "2023-11-07T05:31:56Z",
      "message": "<string>"
    },
    "result": {},
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "attemptCount": 1,
    "estimatedCompletionMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "request_id": "req_a1b2c3d4e5f6",
    "docs_url": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Headers

Scripe-Api-Version

string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-10"

Idempotency-Key

string

Opaque string (1–64 chars, [A-Za-z0-9_-]) used to dedup retried writes. Within 24h of the first request, the same key

same body returns the original response (Idempotent-Replayed: true). Same key + different body returns 409 idempotency_key_conflict.

Strongly recommended for every write — see /docs/api/v1/idempotency.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Body

application/json

projectId

string

required

Example:

"proj_a1b2c3d4e5f6g7h8"

topic

string

required

The core idea the deck communicates. A whole post body is fine — the planner reads it as the brief.

Maximum string length: 8000

steer

string

Explicit instruction that takes priority — audience, angle, tone, things to avoid.

Maximum string length: 4000

outline

string

A slide-by-slide outline to honour verbatim. Goes to the PLANNER, the only step that can actually respect slide count and order; omit it to let the planner storyboard the deck.

Maximum string length: 4000

templateId

string

Force one of the shipped carousel designs. Omitted — or unknown — and the model picks the best fit for the topic. The workspace's default company design, when one is saved, wins over the model's pick.

Maximum string length: 100

wait_for_completion_ms

integer

Soft hint — server polls for up to this many ms before returning. Capped at 25 000 ms. A carousel usually takes longer, so polling is the intended path.

Required range: 0 <= x <= 25000

Response

Job enqueued (or finished, on a sync-wait hit).

data

object

required

Show child attributes

Health

Workspace

Projects

Notes

Posts

Analytics

Sources

Uploads

Knowledge

Jobs

Webhooks

Calendar

Ideas

Media

Settings

Generate a carousel into the media library asynchronously

Authorizations

Headers

Body

Response