Tool reference
61 customer tools. Expand a tool for its exact arguments, input example, result fields, and nested schemas. Use your own returned IDs and a new key for each intended mutation.
All writes require idempotency_key. Optional workspace_id selects a workspace you belong to; otherwise the connection's default applies. Read-only connections can discover write tools but cannot execute them.
Examples use fictional data and may show only selected result fields. They are not records of live generation or publication. Full route result schemas are included, with the MCP workspace envelope. JSON Schema cannot express every cross-field or route rule; consult workflows for those conditions.
Workspace and discovery
get_workspaceRead
Read the active brand workspace and credit balance.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: user, workspace, workspaces, plan, trialEndsAt, promoOfferEndsAt, compOfferPlanId, creditBalance, expiringCredits.
{
"workspace": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "Example",
"onboardedAt": "2026-10-02T00:00:00.000Z",
"planOfferedAt": "2026-10-02T00:00:00.000Z",
"niches": [],
"nicheLabel": "Example",
"nicheCategory": "Example",
"nicheSubcategory": "Example",
"contributesToGlobalLearning": false,
"role": "Example",
"goals": [],
"website": "Example",
"access": "active",
"openingShoot": "pending"
},
"workspaces": [],
"creditBalance": 0,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatarUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatarIsCustom": {
"type": "boolean"
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"internalAccess": {
"type": "boolean"
},
"staffRole": {
"anyOf": [
{
"type": "string",
"enum": [
"staff",
"admin"
]
},
{
"type": "null"
}
]
},
"agreedTerms": {
"type": "boolean"
}
},
"required": [
"id",
"email",
"name",
"avatarUrl",
"avatarIsCustom",
"timezone",
"internalAccess",
"staffRole",
"agreedTerms"
],
"additionalProperties": false
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"onboardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"planOfferedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"niches": {
"type": "array",
"items": {
"type": "string"
}
},
"nicheLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nicheCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nicheSubcategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contributesToGlobalLearning": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"goals": {
"type": "array",
"items": {
"type": "string"
}
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"access": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"openingShoot": {
"type": "string",
"enum": [
"pending",
"failed",
"ready"
]
}
},
"required": [
"id",
"name",
"onboardedAt",
"planOfferedAt",
"niches",
"nicheLabel",
"nicheCategory",
"nicheSubcategory",
"contributesToGlobalLearning",
"role",
"goals",
"website",
"access",
"openingShoot"
],
"additionalProperties": false
},
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"onboardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"access": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"onboardedAt",
"access",
"role"
],
"additionalProperties": false
}
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"tagline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"priceMonthlyCents": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"priceYearlyCents": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"creditsPerMonth": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"workspaceQuota": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"feedCap": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"feedRenewsDaily": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"sort": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"required": [
"id",
"name",
"tagline",
"priceMonthlyCents",
"priceYearlyCents",
"creditsPerMonth",
"workspaceQuota",
"feedCap",
"feedRenewsDaily",
"features",
"sort"
],
"additionalProperties": false
},
"trialEndsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"promoOfferEndsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"compOfferPlanId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"expiringCredits": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"user",
"workspace",
"workspaces",
"plan",
"trialEndsAt",
"promoOfferEndsAt",
"compOfferPlanId",
"creditBalance",
"expiringCredits",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_brandRead
Read the brand profile, voice, angles, segments, and competitors.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, name, website, region, businessModel, contentLanguage, audienceDescription, coreIdentity, productOffering, uniqueBenefits, problemSolved, mission, differentiation, ownedSpace, categoryAnswer, nicheLabel, pinnedHashtags, voiceSamples, siteIdentity, updatedAt, angles, voice, competitors, segments.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"businessModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contentLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"audienceDescription": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coreIdentity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"productOffering": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"uniqueBenefits": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"problemSolved": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mission": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"differentiation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"ownedSpace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"categoryAnswer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nicheLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pinnedHashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceSamples": {
"type": "array",
"items": {
"type": "string"
}
},
"siteIdentity": {
"anyOf": [
{
"type": "object",
"properties": {
"headlineFamily": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headlineKey": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
{
"type": "null"
}
]
},
"bodyFamily": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bodyKey": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
{
"type": "null"
}
]
},
"palette": {
"type": "object",
"properties": {
"accent": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
]
},
"secondary": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
]
},
"wash": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
]
},
"ink": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
]
}
},
"required": [
"accent",
"secondary",
"wash",
"ink"
],
"additionalProperties": false
},
"logoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"logoStoragePath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"logoBackground": {
"type": "string",
"enum": [
"white",
"grey"
]
},
"logoSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"headlineFamily",
"headlineKey",
"bodyFamily",
"bodyKey",
"palette",
"logoUrl",
"logoStoragePath",
"logoBackground",
"logoSrc"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"angles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"title": {
"type": "string"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sort": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"required": [
"id",
"workspaceId",
"title",
"note",
"sort"
],
"additionalProperties": false
}
},
"voice": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"do",
"dont"
]
},
"text": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"kind",
"text"
],
"additionalProperties": false
}
},
"competitors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"url"
],
"additionalProperties": false
}
},
"segments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"pct": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"required": [
"id",
"workspaceId",
"name",
"pct"
],
"additionalProperties": false
}
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"name",
"website",
"region",
"businessModel",
"contentLanguage",
"audienceDescription",
"coreIdentity",
"productOffering",
"uniqueBenefits",
"problemSolved",
"mission",
"differentiation",
"ownedSpace",
"categoryAnswer",
"nicheLabel",
"pinnedHashtags",
"voiceSamples",
"siteIdentity",
"updatedAt",
"angles",
"voice",
"competitors",
"segments",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_workspacesRead
List the brand workspaces this user can access.
Parameters
| Name | Required | Type and constraints |
|---|
Input example
{}Full input schema
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: user, workspace, workspaces, plan, trialEndsAt, promoOfferEndsAt, compOfferPlanId, creditBalance, expiringCredits.
{
"workspace": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "Example",
"onboardedAt": "2026-10-02T00:00:00.000Z",
"planOfferedAt": "2026-10-02T00:00:00.000Z",
"niches": [],
"nicheLabel": "Example",
"nicheCategory": "Example",
"nicheSubcategory": "Example",
"contributesToGlobalLearning": false,
"role": "Example",
"goals": [],
"website": "Example",
"access": "active",
"openingShoot": "pending"
},
"workspaces": [],
"creditBalance": 0,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatarUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatarIsCustom": {
"type": "boolean"
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"internalAccess": {
"type": "boolean"
},
"staffRole": {
"anyOf": [
{
"type": "string",
"enum": [
"staff",
"admin"
]
},
{
"type": "null"
}
]
},
"agreedTerms": {
"type": "boolean"
}
},
"required": [
"id",
"email",
"name",
"avatarUrl",
"avatarIsCustom",
"timezone",
"internalAccess",
"staffRole",
"agreedTerms"
],
"additionalProperties": false
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"onboardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"planOfferedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"niches": {
"type": "array",
"items": {
"type": "string"
}
},
"nicheLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nicheCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nicheSubcategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contributesToGlobalLearning": {
"type": "boolean"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"goals": {
"type": "array",
"items": {
"type": "string"
}
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"access": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"openingShoot": {
"type": "string",
"enum": [
"pending",
"failed",
"ready"
]
}
},
"required": [
"id",
"name",
"onboardedAt",
"planOfferedAt",
"niches",
"nicheLabel",
"nicheCategory",
"nicheSubcategory",
"contributesToGlobalLearning",
"role",
"goals",
"website",
"access",
"openingShoot"
],
"additionalProperties": false
},
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"onboardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"access": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"onboardedAt",
"access",
"role"
],
"additionalProperties": false
}
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"tagline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"priceMonthlyCents": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"priceYearlyCents": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"creditsPerMonth": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"workspaceQuota": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"feedCap": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"feedRenewsDaily": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"sort": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"required": [
"id",
"name",
"tagline",
"priceMonthlyCents",
"priceYearlyCents",
"creditsPerMonth",
"workspaceQuota",
"feedCap",
"feedRenewsDaily",
"features",
"sort"
],
"additionalProperties": false
},
"trialEndsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"promoOfferEndsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"compOfferPlanId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"expiringCredits": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"user",
"workspace",
"workspaces",
"plan",
"trialEndsAt",
"promoOfferEndsAt",
"compOfferPlanId",
"creditBalance",
"expiringCredits",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_contentRead
List content in a brand workspace.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
jobId | No / conditional | uuid |
status | No / conditional | "draft" | "shortlisted" | "approved" | "rejected" | "scheduled" | "posted" | "needs_attention" |
format | No / conditional | "slideshow" | "wall_of_text" | "video" | "green_screen" | "hook_demo" | "talking_head" | "photo_reel" |
source | No / conditional | "face_swap" | "multiply" | "tweak" |
surface | No / conditional | "studio" | "library" | "turbo_history" |
limit | No / conditional | integerminimum: 1maximum: 200 |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"source": {
"type": "string",
"enum": [
"face_swap",
"multiply",
"tweak"
]
},
"surface": {
"type": "string",
"enum": [
"studio",
"library",
"turbo_history"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"coverUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverOverlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"coverUrl",
"coverOverlayBoxes",
"renderedUrl",
"renderedDurationMs",
"renderStale"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_contentRead
Read one content item with its slides.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111"
}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt, slides, renderedUrl, renderedDurationMs, renderStale.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"slides": [],
"renderStale": false,
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_accountsRead
List the brand's connected social accounts.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_productsRead
List products in the brand catalogue.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"folder": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"product",
"add_on",
"variant"
]
},
"listingRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"productUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceImageUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"storagePath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiDescription": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"structuredMetadata": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"featuredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"imageUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"folder",
"name",
"category",
"description",
"price",
"role",
"listingRank",
"productUrl",
"sourceImageUrl",
"storagePath",
"aiDescription",
"structuredMetadata",
"featuredAt",
"createdAt",
"imageUrl"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_discoverRead
Browse discovered trends by category, platform, source kind, search, and limit.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
category | No / conditional | "hook" | "format" | "topic" | "sound" |
platform | No / conditional | "tiktok" | "instagram" |
sourceKind | No / conditional | "slideshow" | "video" |
search | No / conditional | stringminLength: 1 |
limit | No / conditional | integerminimum: 1maximum: 100 |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"enum": [
"hook",
"format",
"topic",
"sound"
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"sourceKind": {
"type": "string",
"enum": [
"slideshow",
"video"
]
},
"search": {
"type": "string",
"minLength": 1
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: items, refreshing, lastRefreshFailed.
{
"items": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"externalId": {
"type": "string"
},
"externalUrl": {
"type": "string"
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourceVideoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"category": {
"type": "string",
"enum": [
"hook",
"format",
"topic",
"sound"
]
},
"lane": {
"type": "string",
"enum": [
"niche",
"format_borrow",
"cultural"
]
},
"momentumLabel": {
"type": "string"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"velocity": {
"anyOf": [
{
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
{
"type": "null"
}
]
},
"niche": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enrichment": {
"type": "object",
"properties": {
"hook": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo"
]
},
"slideCount": {
"type": "number"
},
"hookShape": {
"type": "string"
},
"voiceSignature": {
"type": "string"
},
"ctaSlot": {
"type": "string",
"enum": [
"parenthetical_in_hook",
"final_slide_winner",
"caption_only",
"none"
]
},
"slideSkeleton": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"hook",
"item",
"payoff"
]
},
"beat": {
"type": "string"
},
"microFormat": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sentences": {
"type": "integer",
"minimum": 0
},
"words": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "integer",
"minimum": 0
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"shot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasPrimarySubject": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"keepSourceMedia": {
"type": "boolean"
}
},
"required": [
"role",
"beat",
"microFormat",
"sentences",
"words",
"lines"
],
"additionalProperties": false
}
},
"summary": {
"type": "string"
},
"whyItFits": {
"type": "string"
},
"angles": {
"type": "array",
"items": {
"type": "string"
}
},
"remixValue": {
"type": "number"
},
"sound": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"title",
"url"
],
"additionalProperties": false
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"hookShot": {
"anyOf": [
{
"type": "object",
"properties": {
"opening": {
"type": "string"
},
"closing": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"production": {
"type": "string",
"enum": [
"phone",
"produced"
]
}
},
"required": [
"opening",
"closing",
"production"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hookSeconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"overlayBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atSeconds": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"atSeconds",
"text"
],
"additionalProperties": false
}
},
"subjectKind": {
"anyOf": [
{
"type": "string",
"enum": [
"animal",
"person",
"object"
]
},
{
"type": "null"
}
]
},
"semanticBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
"visual": {
"type": "string"
},
"audioCue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"startSeconds",
"endSeconds",
"visual",
"audioCue"
],
"additionalProperties": false
}
},
"cuts": {
"type": "array",
"items": {
"type": "number"
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"whatChanges": {
"type": "string"
},
"hasPrimarySubject": {
"type": "boolean"
}
},
"required": [
"whatChanges",
"hasPrimarySubject"
],
"additionalProperties": false
}
},
"durationSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"hook",
"format",
"slideCount",
"hookShape",
"voiceSignature",
"ctaSlot",
"slideSkeleton",
"summary",
"whyItFits",
"angles",
"subjectKind",
"semanticBeats"
],
"additionalProperties": false
},
"fetchedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"coverUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slideUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"saved": {
"type": "boolean"
}
},
"required": [
"id",
"workspaceId",
"platform",
"externalId",
"externalUrl",
"handle",
"title",
"coverMediaId",
"sourceVideoMediaId",
"category",
"lane",
"momentumLabel",
"views",
"likes",
"velocity",
"niche",
"enrichment",
"fetchedAt",
"createdAt",
"coverUrl",
"videoUrl",
"slideUrls",
"saved"
],
"additionalProperties": false
}
},
"refreshing": {
"type": "boolean"
},
"lastRefreshFailed": {
"type": "boolean"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"items",
"refreshing",
"lastRefreshFailed",
"workspaceId",
"brandName"
],
"additionalProperties": true
}prepare_remixRead
Analyze exactly one Discover item, link, pasted source, or remix upload before creating content. For a local file, use prepare_media_upload, upload its bytes, and complete_media_upload with purpose=remix_source, then pass source={kind:upload,mediaIds:[returned IDs]}. General Library media is not a remix upload. This costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
discover_id | No / conditional | uuid |
source | No / conditional | object | object | object |
Input example
{
"source": {
"kind": "pasted",
"text": "Three ways to keep a desk tidy: sort cables into labeled clips, clear the surface at the end of each day, and give every small item a dedicated storage spot."
}
}Full input schema
{
"anyOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"discover_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"discover_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"source": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "link"
},
"url": {
"type": "string",
"format": "uri"
},
"previewToken": {
"type": "string",
"minLength": 1
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "upload"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"maxItems": 10
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"mediaIds"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "pasted"
},
"text": {
"type": "string",
"minLength": 120,
"maxLength": 12000
}
},
"required": [
"kind",
"text"
],
"additionalProperties": false
}
]
}
},
"required": [
"source"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: source, origin, platform, sourceType, photoCount, durationSeconds, generationDurationSeconds, hasText, hasAudio, sourceSound, format, hook, hookOptions, prompt, summary, skeleton, previewMediaIds, analysisToken, readId.
{
"platform": "tiktok",
"format": "slideshow",
"prompt": "Three ways to keep a desk tidy",
"summary": "A three-step desk organization post",
"analysisToken": "returned-signed-analysis-token",
"previewMediaIds": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"source": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"link"
]
},
"url": {
"type": "string",
"format": "uri"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"upload"
]
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"mediaIds"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"pasted"
]
}
},
"required": [
"kind"
],
"additionalProperties": false
}
]
},
"origin": {
"type": "string",
"enum": [
"scan",
"trend"
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram",
"x",
"web",
"upload",
"pasted"
]
},
"sourceType": {
"type": "string",
"enum": [
"carousel",
"video",
"image",
"article"
]
},
"photoCount": {
"type": "integer",
"minimum": 0
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"generationDurationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"hasText": {
"type": "boolean"
},
"hasAudio": {
"type": "boolean"
},
"sourceSound": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"format": "uri"
},
"viral": {
"type": "boolean"
}
},
"required": [
"title",
"url",
"viral"
],
"additionalProperties": false
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"hook": {
"type": "string",
"maxLength": 500
},
"hookOptions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500
},
"minItems": 1,
"maxItems": 3
},
"prompt": {
"type": "string",
"maxLength": 5000
},
"summary": {
"type": "string",
"maxLength": 1000
},
"skeleton": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"niche": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"seed",
"scraped"
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo"
]
},
"slideCount": {
"type": "integer",
"exclusiveMinimum": true,
"minimum": 0
},
"hookShape": {
"type": "string"
},
"voiceSignature": {
"type": "string"
},
"ctaSlot": {
"type": "string",
"enum": [
"parenthetical_in_hook",
"final_slide_winner",
"caption_only",
"none"
]
},
"slideSkeleton": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"hook",
"item",
"payoff"
]
},
"beat": {
"type": "string"
},
"microFormat": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sentences": {
"type": "integer",
"minimum": 0
},
"words": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "integer",
"minimum": 0
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"shot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasPrimarySubject": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"keepSourceMedia": {
"type": "boolean"
}
},
"required": [
"role",
"beat",
"microFormat",
"sentences",
"words",
"lines"
],
"additionalProperties": false
},
"minItems": 1
},
"hookShot": {
"anyOf": [
{
"type": "object",
"properties": {
"opening": {
"type": "string"
},
"closing": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"production": {
"type": "string",
"enum": [
"phone",
"produced"
]
}
},
"required": [
"opening",
"closing",
"production"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hookSeconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"subjectKind": {
"anyOf": [
{
"type": "string",
"enum": [
"animal",
"person",
"object"
]
},
{
"type": "null"
}
]
},
"sourceIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"dance",
"stunt",
"workout",
"walk",
"talk",
"demo",
"other"
],
"default": null
},
{
"type": "null"
}
]
},
"hasAudibleSpeech": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"screenshotOf": {
"anyOf": [
{
"type": "boolean",
"default": null
},
{
"type": "null"
}
]
},
"semanticBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
"visual": {
"type": "string"
},
"audioCue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"startSeconds",
"endSeconds",
"visual",
"audioCue"
],
"additionalProperties": false
}
},
"visualInserts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
"anchorText": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"proof",
"example",
"product",
"joke",
"interface",
"other"
]
},
"kind": {
"type": "string",
"enum": [
"photo",
"illustration",
"screenshot",
"card"
]
},
"coverage": {
"type": "string",
"enum": [
"overlay",
"full"
]
},
"description": {
"type": "string",
"minLength": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"anchorText",
"role",
"kind",
"coverage",
"description",
"frame",
"entrance",
"exit"
],
"additionalProperties": false
},
"default": []
},
"overlayBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atSeconds": {
"type": "number"
},
"endSeconds": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"atSeconds",
"text"
],
"additionalProperties": false
}
},
"spokenWords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"overlayLook": {
"anyOf": [
{
"type": "object",
"properties": {
"background": {
"type": "string",
"enum": [
"box_light",
"box_dark",
"outline",
"none"
]
},
"position": {
"type": "string",
"enum": [
"top",
"middle",
"lower"
]
},
"textCase": {
"type": "string",
"enum": [
"lower",
"sentence",
"upper"
]
},
"textColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"backgroundColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
}
},
"required": [
"background",
"position",
"textCase"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cuts": {
"type": "array",
"items": {
"type": "number"
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"whatChanges": {
"type": "string"
},
"hasPrimarySubject": {
"type": "boolean"
}
},
"required": [
"whatChanges",
"hasPrimarySubject"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"niche",
"source",
"format",
"slideCount",
"hookShape",
"voiceSignature",
"ctaSlot",
"slideSkeleton",
"hookShot",
"hookSeconds",
"durationSeconds",
"subjectKind",
"semanticBeats",
"overlayBeats",
"cuts",
"shots"
],
"additionalProperties": false
},
"previewMediaIds": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"analysisToken": {
"type": "string",
"minLength": 1
},
"readId": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"source",
"origin",
"platform",
"sourceType",
"photoCount",
"durationSeconds",
"generationDurationSeconds",
"hasText",
"hasAudio",
"format",
"hook",
"hookOptions",
"prompt",
"summary",
"skeleton",
"analysisToken",
"readId",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Influencers
list_influencersRead
List the influencers available to this brand.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"ethnicity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"gender",
"age",
"ethnicity",
"description",
"profileConfig",
"voicePreset",
"speakingVoiceId",
"speakingVoiceSource",
"profilePhotoMediaId",
"status",
"createdAt",
"updatedAt",
"profilePhotoUrl"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}create_influencerWrite
Create an influencer with their identity, character, and reference assets. Costs 125 credits once, including their first face shoot.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
name | Yes | stringminLength: 1maxLength: 200 |
gender | No / conditional | string | null |
age | No / conditional | integer | null |
ethnicity | No / conditional | string | null |
description | No / conditional | string | null |
bible | No / conditional | See full schema | null |
profileConfig | No / conditional | object | null |
voicePreset | No / conditional | string | null |
speakingVoiceId | No / conditional | string | null |
speakingVoiceSource | No / conditional | "preset" | "cloned" | null |
profilePhotoMediaId | No / conditional | uuid | null |
referencePhotoMediaIds | No / conditional | arraymaxItems: 5 |
lookSeedMediaId | No / conditional | uuid | null |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"name": "Alex",
"idempotency_key": "create_influencer-example-1",
"age": 28,
"description": "A friendly guide to tidy workspaces"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"gender": {
"type": [
"string",
"null"
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": 18,
"maximum": 99
},
{
"type": "null"
}
]
},
"ethnicity": {
"type": [
"string",
"null"
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"type": [
"string",
"null"
]
},
"speakingVoiceId": {
"type": [
"string",
"null"
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"referencePhotoMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"lookSeedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, name, gender, age, ethnicity, description, bible, profileConfig, voicePreset, speakingVoiceId, speakingVoiceSource, profilePhotoMediaId, status, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "Alex",
"age": 0,
"speakingVoiceId": "Example",
"status": "draft",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"ethnicity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"name",
"gender",
"age",
"ethnicity",
"description",
"profileConfig",
"voicePreset",
"speakingVoiceId",
"speakingVoiceSource",
"profilePhotoMediaId",
"status",
"createdAt",
"updatedAt",
"profilePhotoUrl",
"workspaceId",
"brandName"
],
"additionalProperties": true
}update_influencerWrite
Edit an influencer's identity, character, reference assets, archive state, or preset voice using the existing influencer settings.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
influencer_id | Yes | uuid |
name | No / conditional | stringminLength: 1maxLength: 200 |
gender | No / conditional | string | null |
age | No / conditional | integer | null |
ethnicity | No / conditional | string | null |
description | No / conditional | string | null |
bible | No / conditional | See full schema | null |
profileConfig | No / conditional | object | null |
voicePreset | No / conditional | string | null |
speakingVoiceId | No / conditional | string | null |
speakingVoiceSource | No / conditional | "preset" | "cloned" | null |
profilePhotoMediaId | No / conditional | uuid | null |
status | No / conditional | "draft" | "active" | "archived" |
lookSeedMediaId | No / conditional | uuid | null |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"influencer_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "update_influencer-example-1",
"description": "A practical guide to tidy workspaces"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"influencer_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"influencer_id"
]
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"gender": {
"type": [
"string",
"null"
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": 18,
"maximum": 99
},
{
"type": "null"
}
]
},
"ethnicity": {
"type": [
"string",
"null"
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"type": [
"string",
"null"
]
},
"speakingVoiceId": {
"type": [
"string",
"null"
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"lookSeedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, name, gender, age, ethnicity, description, bible, profileConfig, voicePreset, speakingVoiceId, speakingVoiceSource, profilePhotoMediaId, status, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "Example",
"age": 0,
"speakingVoiceId": "Example",
"status": "draft",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"ethnicity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"name",
"gender",
"age",
"ethnicity",
"description",
"profileConfig",
"voicePreset",
"speakingVoiceId",
"speakingVoiceSource",
"profilePhotoMediaId",
"status",
"createdAt",
"updatedAt",
"profilePhotoUrl",
"workspaceId",
"brandName"
],
"additionalProperties": true
}delete_influencerWrite
Permanently delete an influencer and release their cloned voice. Only call when the user explicitly requests deletion and confirm=true.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
influencer_id | Yes | uuid |
confirm | Yes | true |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"influencer_id": "11111111-1111-4111-8111-111111111111",
"confirm": true,
"idempotency_key": "delete_influencer-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"influencer_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"influencer_id"
]
},
{
"type": "object",
"properties": {
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"confirm"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, name, gender, age, ethnicity, description, bible, profileConfig, voicePreset, speakingVoiceId, speakingVoiceSource, profilePhotoMediaId, status, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "Example",
"age": 0,
"speakingVoiceId": "Example",
"status": "draft",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"age": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"ethnicity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bible": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"voicePreset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"speakingVoiceSource": {
"anyOf": [
{
"type": "string",
"enum": [
"preset",
"cloned"
]
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"name",
"gender",
"age",
"ethnicity",
"description",
"profileConfig",
"voicePreset",
"speakingVoiceId",
"speakingVoiceSource",
"profilePhotoMediaId",
"status",
"createdAt",
"updatedAt",
"profilePhotoUrl",
"workspaceId",
"brandName"
],
"additionalProperties": true
}draft_influencer_identityWrite
Draft a influencer identity from the brand context. Costs 5 credits. Save the result with create_influencer.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
description | No / conditional | stringmaxLength: 2000 |
name | No / conditional | stringmaxLength: 200 |
gender | No / conditional | string | null |
age | No / conditional | integer | null |
ethnicity | No / conditional | string | null |
voicePreset | No / conditional | string | null |
profileConfig | No / conditional | object | null |
photoMediaIds | No / conditional | arraymaxItems: 5 |
photoIntent | No / conditional | "likeness" | "look_seed" |
avoidName | No / conditional | stringmaxLength: 200 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"idempotency_key": "draft_influencer_identity-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 2000
},
"name": {
"type": "string",
"maxLength": 200
},
"gender": {
"type": [
"string",
"null"
]
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ethnicity": {
"type": [
"string",
"null"
]
},
"voicePreset": {
"type": [
"string",
"null"
]
},
"profileConfig": {
"anyOf": [
{
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"photoMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"photoIntent": {
"type": "string",
"enum": [
"likeness",
"look_seed"
]
},
"avoidName": {
"type": "string",
"maxLength": 200
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: name, gender, age, ethnicity, voicePreset, profileConfig.
{
"name": "Alex",
"age": 28,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ethnicity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"voicePreset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profileConfig": {
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"name",
"gender",
"age",
"ethnicity",
"voicePreset",
"profileConfig",
"workspaceId",
"brandName"
],
"additionalProperties": true
}draft_influencer_characterWrite
Complete the character for a drafted influencer identity. Costs no additional credits. Save the result with create_influencer or update_influencer.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
name | Yes | string |
gender | No / conditional | string | null |
age | No / conditional | integer | null |
ethnicity | No / conditional | string | null |
voicePreset | No / conditional | string | null |
profileConfig | No / conditional | object |
description | No / conditional | stringmaxLength: 2000 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"name": "Alex",
"idempotency_key": "draft_influencer_character-example-1",
"age": 28
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"gender": {
"type": [
"string",
"null"
]
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ethnicity": {
"type": [
"string",
"null"
]
},
"voicePreset": {
"type": [
"string",
"null"
]
},
"profileConfig": {
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"name"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: bible.
{
"bible": {
"identity": {
"niche": "Example",
"owns": "Example",
"audienceImpression": "Example",
"brandPromise": "Example"
},
"beliefs": {
"messagingPillars": [],
"hotTakes": []
},
"voice": {
"tone": [],
"principles": [],
"writingStyle": "Example"
},
"phrases": {
"examplePhrases": [],
"bannedPhrases": []
},
"contentPillars": [],
"captionFrameworks": []
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"bible": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"niche": {
"type": "string"
},
"owns": {
"type": "string"
},
"audienceImpression": {
"type": "string"
},
"brandPromise": {
"type": "string"
}
},
"required": [
"niche",
"owns",
"audienceImpression",
"brandPromise"
],
"additionalProperties": false
},
"beliefs": {
"type": "object",
"properties": {
"messagingPillars": {
"type": "array",
"items": {
"type": "string"
}
},
"hotTakes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"messagingPillars",
"hotTakes"
],
"additionalProperties": false
},
"voice": {
"type": "object",
"properties": {
"tone": {
"type": "array",
"items": {
"type": "string"
}
},
"principles": {
"type": "array",
"items": {
"type": "string"
}
},
"writingStyle": {
"type": "string"
}
},
"required": [
"tone",
"principles",
"writingStyle"
],
"additionalProperties": false
},
"phrases": {
"type": "object",
"properties": {
"examplePhrases": {
"type": "array",
"items": {
"type": "string"
}
},
"bannedPhrases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"examplePhrases",
"bannedPhrases"
],
"additionalProperties": false
},
"contentPillars": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"ownedQuestions": {
"type": "array",
"items": {
"type": "string"
}
},
"hookDirections": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"topics",
"ownedQuestions",
"hookDirections"
],
"additionalProperties": false
}
},
"captionFrameworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"steps"
],
"additionalProperties": false
}
}
},
"required": [
"identity",
"beliefs",
"voice",
"phrases",
"contentPillars",
"captionFrameworks"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"bible",
"workspaceId",
"brandName"
],
"additionalProperties": true
}redraft_influencer_characterWrite
Redraft a influencer's character. Costs 5 credits. Save the result with update_influencer.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
name | Yes | string |
gender | No / conditional | string | null |
age | No / conditional | integer | null |
ethnicity | No / conditional | string | null |
voicePreset | No / conditional | string | null |
profileConfig | No / conditional | object |
description | No / conditional | stringmaxLength: 2000 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"name": "Alex",
"idempotency_key": "redraft_influencer_character-example-1",
"age": 28,
"description": "Make their character more practical"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"gender": {
"type": [
"string",
"null"
]
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ethnicity": {
"type": [
"string",
"null"
]
},
"voicePreset": {
"type": [
"string",
"null"
]
},
"profileConfig": {
"type": "object",
"properties": {
"pronouns": {
"type": "string",
"maxLength": 500
},
"primaryLanguage": {
"type": "string",
"maxLength": 500
},
"appearance": {
"type": "object",
"properties": {
"hairColor": {
"type": "string",
"maxLength": 500
},
"hairStyle": {
"type": "string",
"maxLength": 500
},
"eyeColor": {
"type": "string",
"maxLength": 500
},
"skinTone": {
"type": "string",
"maxLength": 500
},
"bodyType": {
"type": "string",
"maxLength": 500
},
"heightCm": {
"anyOf": [
{
"type": "integer",
"minimum": 100,
"maximum": 250
},
{
"type": "null"
}
]
},
"distinguishingFeatures": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"hairColor",
"hairStyle",
"eyeColor",
"skinTone",
"bodyType",
"heightCm",
"distinguishingFeatures"
],
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"location": {
"type": "string",
"maxLength": 500
},
"occupation": {
"type": "string",
"maxLength": 500
},
"education": {
"type": "string",
"maxLength": 500
},
"income": {
"type": "string",
"maxLength": 500
},
"relationshipStatus": {
"type": "string",
"maxLength": 500
},
"children": {
"type": "string",
"maxLength": 500
}
},
"required": [
"location",
"occupation",
"education",
"income",
"relationshipStatus",
"children"
],
"additionalProperties": false
},
"creatorContext": {
"type": "object",
"properties": {
"roleArchetype": {
"type": "string",
"maxLength": 500
},
"contentPurposes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"personalBackground": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"roleArchetype",
"contentPurposes",
"personalBackground"
],
"additionalProperties": false
},
"visualPreferences": {
"type": "object",
"properties": {
"wardrobe": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"recurringLocations": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"signatureAccessories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
}
},
"required": [
"wardrobe",
"recurringLocations",
"signatureAccessories",
"avoid"
],
"additionalProperties": false
},
"contentBoundaries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 20
},
"storyAnchors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"pronouns",
"primaryLanguage",
"appearance",
"background",
"creatorContext",
"visualPreferences",
"contentBoundaries",
"storyAnchors"
],
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"name"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: bible.
{
"bible": {
"identity": {
"niche": "Example",
"owns": "Example",
"audienceImpression": "Example",
"brandPromise": "Example"
},
"beliefs": {
"messagingPillars": [],
"hotTakes": []
},
"voice": {
"tone": [],
"principles": [],
"writingStyle": "Example"
},
"phrases": {
"examplePhrases": [],
"bannedPhrases": []
},
"contentPillars": [],
"captionFrameworks": []
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"bible": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"niche": {
"type": "string"
},
"owns": {
"type": "string"
},
"audienceImpression": {
"type": "string"
},
"brandPromise": {
"type": "string"
}
},
"required": [
"niche",
"owns",
"audienceImpression",
"brandPromise"
],
"additionalProperties": false
},
"beliefs": {
"type": "object",
"properties": {
"messagingPillars": {
"type": "array",
"items": {
"type": "string"
}
},
"hotTakes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"messagingPillars",
"hotTakes"
],
"additionalProperties": false
},
"voice": {
"type": "object",
"properties": {
"tone": {
"type": "array",
"items": {
"type": "string"
}
},
"principles": {
"type": "array",
"items": {
"type": "string"
}
},
"writingStyle": {
"type": "string"
}
},
"required": [
"tone",
"principles",
"writingStyle"
],
"additionalProperties": false
},
"phrases": {
"type": "object",
"properties": {
"examplePhrases": {
"type": "array",
"items": {
"type": "string"
}
},
"bannedPhrases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"examplePhrases",
"bannedPhrases"
],
"additionalProperties": false
},
"contentPillars": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"ownedQuestions": {
"type": "array",
"items": {
"type": "string"
}
},
"hookDirections": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"topics",
"ownedQuestions",
"hookDirections"
],
"additionalProperties": false
}
},
"captionFrameworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"steps"
],
"additionalProperties": false
}
}
},
"required": [
"identity",
"beliefs",
"voice",
"phrases",
"contentPillars",
"captionFrameworks"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"bible",
"workspaceId",
"brandName"
],
"additionalProperties": true
}clone_influencer_voiceWrite
Clone a influencer's speaking voice from an existing uploaded recording. Requires the user's recorded voice permission; never record consent on their behalf without an explicit answer.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
influencer_id | Yes | uuid |
mediaId | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"influencer_id": "11111111-1111-4111-8111-111111111111",
"mediaId": "22222222-2222-4222-8222-222222222222",
"idempotency_key": "clone_influencer_voice-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"influencer_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"influencer_id"
]
},
{
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"mediaId"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: speakingVoiceId, auditionUrl.
{
"speakingVoiceId": "returned-voice-id",
"auditionUrl": "https://example.com/signed-audition",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"speakingVoiceId": {
"type": "string"
},
"auditionUrl": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"speakingVoiceId",
"auditionUrl",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Media and uploads
list_mediaRead
Browse brand media with the existing kind, purpose, source, category, search, and pagination filters.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
jobId | No / conditional | uuid |
influencerId | No / conditional | uuid |
kind | No / conditional | "image" | "video" | "audio" |
purpose | No / conditional | "general" | "identity_reference" | "product_demo" | "meme_template" | "feedback" | "remix_source" | "curated" | "music_cue" | "post_upload" | "chat_attachment" |
source | No / conditional | "generated" | "uploaded" | "pinterest" | "crawled" | "seed" | "site" | "social" |
scope | No / conditional | "clips" |
category | No / conditional | stringminLength: 1maxLength: 60 |
q | No / conditional | stringminLength: 1maxLength: 60 |
offset | No / conditional | integerminimum: 0 |
limit | No / conditional | integerminimum: 1maximum: 50 |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"jobId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
"purpose": {
"type": "string",
"enum": [
"general",
"identity_reference",
"product_demo",
"meme_template",
"feedback",
"remix_source",
"curated",
"music_cue",
"post_upload",
"chat_attachment"
]
},
"source": {
"type": "string",
"enum": [
"generated",
"uploaded",
"pinterest",
"crawled",
"seed",
"site",
"social"
]
},
"scope": {
"type": "string",
"enum": [
"clips"
]
},
"category": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"q": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
"source": {
"type": "string",
"enum": [
"generated",
"uploaded",
"pinterest",
"crawled",
"seed",
"site",
"social"
]
},
"purpose": {
"type": "string",
"enum": [
"general",
"identity_reference",
"product_demo",
"meme_template",
"feedback",
"remix_source",
"curated",
"music_cue",
"post_upload",
"chat_attachment"
]
},
"storagePath": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"isAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"provenClaims": {
"type": "array",
"items": {
"type": "string"
}
},
"reviewedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"unusableAs": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"shared": {
"type": "boolean"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"kind",
"source",
"purpose",
"storagePath",
"mimeType",
"width",
"height",
"durationMs",
"isAiGenerated",
"influencerId",
"description",
"tags",
"provenClaims",
"reviewedAt",
"unusableAs",
"createdAt",
"title",
"shared",
"url"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}prepare_media_uploadWrite
Prepare an upload for a local image, video, or audio file, up to 250 MB. Upload the real file bytes to the returned URL using its protocol, headers, and multipart instructions, then call complete_media_upload. Never pass a local file path as a server URL or fabricate base64. Costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
mimeType | Yes | "image/jpeg" | "image/png" | "image/webp" | "image/gif" | "video/mp4" | "video/quicktime" | "video/webm" | "audio/mpeg" | "audio/webm" | "audio/wav" | "audio/mp4" |
fileSize | Yes | integerexclusiveMinimum: 0maximum: 262144000 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"mimeType": "image/jpeg",
"fileSize": 1048576,
"idempotency_key": "prepare_media_upload-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"mimeType": {
"type": "string",
"enum": [
"image/jpeg",
"image/png",
"image/webp",
"image/gif",
"video/mp4",
"video/quicktime",
"video/webm",
"audio/mpeg",
"audio/webm",
"audio/wav",
"audio/mp4"
]
},
"fileSize": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 262144000
}
},
"required": [
"mimeType",
"fileSize"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: storagePath, uploadUrl, method, protocol, headers, uploadId, partSize, partUrls.
{
"storagePath": "workspaces/example/uploads/photo.jpg",
"uploadUrl": "https://example.com/signed-upload",
"method": "PUT",
"protocol": "raw",
"headers": {},
"uploadInstructions": "PUT the entire file's raw bytes to uploadUrl using returned headers. After a successful upload, call complete_media_upload with storagePath and mimeType.",
"nextAction": {
"tool": "complete_media_upload",
"instruction": "Only complete after every file byte has uploaded successfully. If the signed URL expires, prepare a new upload with a new idempotency_key."
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"storagePath": {
"type": "string",
"minLength": 1
},
"uploadUrl": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"enum": [
"PUT"
]
},
"protocol": {
"type": "string",
"enum": [
"raw",
"supabase_multipart",
"s3_multipart"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"uploadId": {
"type": "string",
"minLength": 1
},
"partSize": {
"type": "integer",
"exclusiveMinimum": true,
"minimum": 0
},
"partUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"storagePath",
"uploadUrl",
"method",
"protocol",
"headers",
"workspaceId",
"brandName"
],
"additionalProperties": true
}complete_media_uploadWrite
Register a successfully uploaded file as brand media. Use storagePath and mimeType from prepare_media_upload. Use purpose=general for Library or post_own_file, or purpose=remix_source for prepare_remix. Returns the media ID. Reference faces require the user's recorded permission.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
storagePath | Yes | stringminLength: 1 |
mimeType | Yes | "image/jpeg" | "image/png" | "image/webp" | "image/gif" | "video/mp4" | "video/quicktime" | "video/webm" | "audio/mpeg" | "audio/webm" | "audio/wav" | "audio/mp4" |
influencerId | No / conditional | uuid |
purpose | No / conditional | "general" | "identity_reference" | "product_demo" | "meme_template" | "feedback" | "remix_source" | "curated" | "music_cue" | "post_upload" | "chat_attachment"default: "general" |
uploadId | No / conditional | stringminLength: 1 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"storagePath": "workspaces/example/uploads/photo.jpg",
"mimeType": "image/jpeg",
"idempotency_key": "complete_media_upload-example-1",
"purpose": "general"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"storagePath": {
"type": "string",
"minLength": 1
},
"mimeType": {
"type": "string",
"enum": [
"image/jpeg",
"image/png",
"image/webp",
"image/gif",
"video/mp4",
"video/quicktime",
"video/webm",
"audio/mpeg",
"audio/webm",
"audio/wav",
"audio/mp4"
]
},
"influencerId": {
"type": "string",
"format": "uuid"
},
"purpose": {
"type": "string",
"enum": [
"general",
"identity_reference",
"product_demo",
"meme_template",
"feedback",
"remix_source",
"curated",
"music_cue",
"post_upload",
"chat_attachment"
],
"default": "general"
},
"uploadId": {
"type": "string",
"minLength": 1
}
},
"required": [
"storagePath",
"mimeType"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, kind, source, purpose, storagePath, mimeType, width, height, durationMs, isAiGenerated, influencerId, description, tags, provenClaims, reviewedAt, unusableAs, createdAt, title, shared, url.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"storagePath": "Example",
"url": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
"source": {
"type": "string",
"enum": [
"generated",
"uploaded",
"pinterest",
"crawled",
"seed",
"site",
"social"
]
},
"purpose": {
"type": "string",
"enum": [
"general",
"identity_reference",
"product_demo",
"meme_template",
"feedback",
"remix_source",
"curated",
"music_cue",
"post_upload",
"chat_attachment"
]
},
"storagePath": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"isAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"provenClaims": {
"type": "array",
"items": {
"type": "string"
}
},
"reviewedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"unusableAs": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"shared": {
"type": "boolean"
},
"url": {
"type": "string"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"kind",
"source",
"purpose",
"storagePath",
"mimeType",
"width",
"height",
"durationMs",
"isAiGenerated",
"influencerId",
"description",
"tags",
"provenClaims",
"reviewedAt",
"unusableAs",
"createdAt",
"title",
"shared",
"url",
"workspaceId",
"brandName"
],
"additionalProperties": true
}abort_media_uploadWrite
Abort an unfinished multipart upload using its storagePath and uploadId.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
storagePath | Yes | stringminLength: 1 |
uploadId | Yes | stringminLength: 1 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"storagePath": "workspaces/example/uploads/video.mp4",
"uploadId": "returned-upload-id",
"idempotency_key": "abort_media_upload-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"storagePath": {
"type": "string",
"minLength": 1
},
"uploadId": {
"type": "string",
"minLength": 1
}
},
"required": [
"storagePath",
"uploadId"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: ok.
{
"ok": true,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"ok",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_media_urlRead
Get a signed preview or download URL for an authorized media asset. Refresh this URL if it expires.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
media_id | Yes | uuid |
Input example
{
"media_id": "11111111-1111-4111-8111-111111111111"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"media_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"media_id"
]
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: url, expiresAt.
{
"url": "https://example.com/signed-preview",
"expiresAt": "2026-10-02T01:00:00.000Z",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"url",
"expiresAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}improve_imageWrite
Improve an existing image with an optional instruction. Costs 1 credits. Returns a jobId; get_job returns the new media IDs.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
media_id | Yes | uuid |
instruction | No / conditional | stringmaxLength: 500 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"media_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "improve_image-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"media_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"media_id"
]
},
{
"type": "object",
"properties": {
"instruction": {
"type": "string",
"maxLength": 500
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status, creditCost.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"creditCost": 1,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"creditCost": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"creditCost",
"workspaceId",
"brandName"
],
"additionalProperties": true
}delete_mediaWrite
Permanently delete a media asset when the existing app rules permit it. Only call when the user explicitly requests deletion and confirm=true.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
media_id | Yes | uuid |
confirm | Yes | true |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"media_id": "11111111-1111-4111-8111-111111111111",
"confirm": true,
"idempotency_key": "delete_media-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"media_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"media_id"
]
},
{
"type": "object",
"properties": {
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"confirm"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: ok.
{
"ok": true,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"ok",
"workspaceId",
"brandName"
],
"additionalProperties": true
}record_media_consentWrite
Record the user's explicit permission to use a reference face or clone a voice. Requires confirm=true. Ask the user first; never infer consent from a file upload or content brief. Use the current consent version from get_studio_options.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
version | Yes | "2026-07-28" |
purposes | Yes | arrayminItems: 1maxItems: 2 |
confirm | Yes | true |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"version": "2026-07-28",
"purposes": [
"biometric_reference_face"
],
"confirm": true,
"idempotency_key": "record_media_consent-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"version": {
"type": "string",
"const": "2026-07-28"
},
"purposes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"biometric_reference_face",
"biometric_voice_clone"
]
},
"minItems": 1,
"maxItems": 2
}
},
"required": [
"version",
"purposes"
]
},
{
"type": "object",
"properties": {
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"confirm"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: ok.
{
"ok": true,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"ok",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Content Studio
create_contentWrite
Create private Content Studio posts, standalone photos (mode=photos), or video clips (mode=videos) in the background. Returns a jobId; use get_job for progress, frame review, and result IDs, then get_content or get_media_url for previews. Planning costs 5 credits, fresh photos cost 5 each, video costs 16 per generated second, and talking heads cost 20 per generated second. The exact total is calculated before dispatch.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
format | Yes | "slideshow" | "wall_of_text" | "video" | "green_screen" | "hook_demo" | "talking_head" | "photo_reel" |
influencerId | No / conditional | uuid |
personaMediaId | No / conditional | uuid |
matchPersonaPhoto | No / conditional | boolean |
targetAccountId | No / conditional | uuid |
prompt | No / conditional | stringminLength: 1 |
imageSource | No / conditional | "fresh" | "auto" | "manual"default: "fresh" |
mediaIds | No / conditional | array |
hookMediaId | No / conditional | uuid |
hookVideoPrompt | No / conditional | stringminLength: 1 |
demoMediaId | No / conditional | uuid |
memeTemplateMediaId | No / conditional | uuid |
backgroundMediaId | No / conditional | uuid |
remixAnalysisToken | No / conditional | stringminLength: 1 |
remixSkeleton | No / conditional | object |
creatorSwap | No / conditional | boolean |
keepSourceSlideIndexes | No / conditional | arraymaxItems: 10 |
remixScanId | No / conditional | stringminLength: 1maxLength: 64 |
mode | No / conditional | "content" | "photos" | "videos"default: "content" |
videoTemplate | No / conditional | "product_faceless_clean_hero" | "product_faceless_pick_up" | "product_faceless_turn_inspect" | "product_faceless_open_close" | "product_faceless_use" | "product_faceless_macro" | "product_creator_present" | "product_creator_use" | "product_creator_try_apply" | "product_creator_unbox" | "product_creator_inspect" | "product_creator_hold_camera" | "broll_hands_work" | "broll_pov_action" | "broll_over_shoulder" | "broll_workspace" | "broll_closeup_process" | "broll_ambient" | "hook_shocked" | "hook_double_take" | "hook_wait_what" | "hook_excited_discovery" | "hook_caught_off_guard" | "hook_point_proof" | "hook_selfie_push_in" | "hook_strike_pose" |
videoSound | No / conditional | boolean |
reviewFrames | No / conditional | boolean |
videoDurationSeconds | No / conditional | 5 | 10 | 15 | 20 | 30 |
talkingHeadSeconds | No / conditional | integerminimum: 4maximum: 30 |
talkingHeadCut | No / conditional | "product" | "creator" |
reuseSourceAudio | No / conditional | boolean |
openingTextMode | No / conditional | "generated" | "source" | "custom" | "none" |
openingText | No / conditional | stringminLength: 1maxLength: 500 |
showBefore | No / conditional | boolean |
beforeAfter | No / conditional | boolean |
productIds | No / conditional | array |
shotTemplate | No / conditional | "hero" | "try_on" | "lifestyle" | "unboxing" |
videoTreatment | No / conditional | "ugc" | "cinematic" |
templateSlug | No / conditional | stringmaxLength: 64 |
savedTemplateId | No / conditional | uuid |
publishedTemplateId | No / conditional | uuid |
templateRun | No / conditional | object |
templateFields | No / conditional | object |
soundLinks | No / conditional | object |
referenceMediaIds | No / conditional | arraymaxItems: 5 |
promptMediaIds | No / conditional | arraymaxItems: 5 |
photoReelSlotMs | No / conditional | integerminimum: 230maximum: 1000 |
aspectRatio | No / conditional | "9:16" | "4:5" | "1:1" | "4:3" | "16:9" |
photoCount | No / conditional | integerminimum: 1maximum: 5 |
faceless | No / conditional | boolean |
reshootFace | No / conditional | boolean |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"format": "slideshow",
"idempotency_key": "create_content-example-1",
"mode": "content",
"prompt": "Three ways to keep a desk tidy",
"imageSource": "fresh"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"influencerId": {
"type": "string",
"format": "uuid"
},
"personaMediaId": {
"type": "string",
"format": "uuid"
},
"matchPersonaPhoto": {
"type": "boolean"
},
"targetAccountId": {
"type": "string",
"format": "uuid"
},
"prompt": {
"type": "string",
"minLength": 1
},
"imageSource": {
"type": "string",
"enum": [
"fresh",
"auto",
"manual"
],
"default": "fresh"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"hookMediaId": {
"type": "string",
"format": "uuid"
},
"hookVideoPrompt": {
"type": "string",
"minLength": 1
},
"demoMediaId": {
"type": "string",
"format": "uuid"
},
"memeTemplateMediaId": {
"type": "string",
"format": "uuid"
},
"backgroundMediaId": {
"type": "string",
"format": "uuid"
},
"remixAnalysisToken": {
"type": "string",
"minLength": 1
},
"remixSkeleton": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"niche": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"seed",
"scraped"
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo"
]
},
"slideCount": {
"type": "integer",
"exclusiveMinimum": 0
},
"hookShape": {
"type": "string"
},
"voiceSignature": {
"type": "string"
},
"ctaSlot": {
"type": "string",
"enum": [
"parenthetical_in_hook",
"final_slide_winner",
"caption_only",
"none"
]
},
"slideSkeleton": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"hook",
"item",
"payoff"
]
},
"beat": {
"type": "string"
},
"microFormat": {
"type": [
"string",
"null"
]
},
"sentences": {
"type": "integer",
"minimum": 0
},
"words": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "integer",
"minimum": 0
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"shot": {
"type": [
"string",
"null"
]
},
"hasPrimarySubject": {
"type": [
"boolean",
"null"
]
},
"keepSourceMedia": {
"type": "boolean"
}
},
"required": [
"role",
"beat",
"microFormat",
"sentences",
"words",
"lines"
],
"additionalProperties": false
},
"minItems": 1
},
"hookShot": {
"anyOf": [
{
"type": "object",
"properties": {
"opening": {
"type": "string"
},
"closing": {
"type": [
"string",
"null"
]
},
"production": {
"type": "string",
"enum": [
"phone",
"produced"
]
}
},
"required": [
"opening",
"closing",
"production"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hookSeconds": {
"type": [
"number",
"null"
]
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"subjectKind": {
"anyOf": [
{
"type": "string",
"enum": [
"animal",
"person",
"object"
]
},
{
"type": "null"
}
]
},
"sourceIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"dance",
"stunt",
"workout",
"walk",
"talk",
"demo",
"other"
]
},
{
"type": "null"
}
],
"default": null
},
"hasAudibleSpeech": {
"type": [
"boolean",
"null"
]
},
"screenshotOf": {
"type": [
"boolean",
"null"
],
"default": null
},
"semanticBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"visual": {
"type": "string"
},
"audioCue": {
"type": [
"string",
"null"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"visual",
"audioCue"
],
"additionalProperties": false
}
},
"visualInserts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"anchorText": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"proof",
"example",
"product",
"joke",
"interface",
"other"
]
},
"kind": {
"type": "string",
"enum": [
"photo",
"illustration",
"screenshot",
"card"
]
},
"coverage": {
"type": "string",
"enum": [
"overlay",
"full"
]
},
"description": {
"type": "string",
"minLength": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"anchorText",
"role",
"kind",
"coverage",
"description",
"frame",
"entrance",
"exit"
],
"additionalProperties": false
},
"default": []
},
"overlayBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atSeconds": {
"type": "number"
},
"endSeconds": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"atSeconds",
"text"
],
"additionalProperties": false
}
},
"spokenWords": {
"type": [
"string",
"null"
]
},
"overlayLook": {
"anyOf": [
{
"type": "object",
"properties": {
"background": {
"type": "string",
"enum": [
"box_light",
"box_dark",
"outline",
"none"
]
},
"position": {
"type": "string",
"enum": [
"top",
"middle",
"lower"
]
},
"textCase": {
"type": "string",
"enum": [
"lower",
"sentence",
"upper"
]
},
"textColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"backgroundColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
}
},
"required": [
"background",
"position",
"textCase"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cuts": {
"type": "array",
"items": {
"type": "number"
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"whatChanges": {
"type": "string"
},
"hasPrimarySubject": {
"type": "boolean"
}
},
"required": [
"whatChanges",
"hasPrimarySubject"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"niche",
"source",
"format",
"slideCount",
"hookShape",
"voiceSignature",
"ctaSlot",
"slideSkeleton",
"hookShot",
"hookSeconds",
"durationSeconds",
"subjectKind",
"semanticBeats",
"overlayBeats",
"cuts",
"shots"
],
"additionalProperties": false
},
"creatorSwap": {
"type": "boolean"
},
"keepSourceSlideIndexes": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"maxItems": 10
},
"remixScanId": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"mode": {
"type": "string",
"enum": [
"content",
"photos",
"videos"
],
"default": "content"
},
"videoTemplate": {
"type": "string",
"enum": [
"product_faceless_clean_hero",
"product_faceless_pick_up",
"product_faceless_turn_inspect",
"product_faceless_open_close",
"product_faceless_use",
"product_faceless_macro",
"product_creator_present",
"product_creator_use",
"product_creator_try_apply",
"product_creator_unbox",
"product_creator_inspect",
"product_creator_hold_camera",
"broll_hands_work",
"broll_pov_action",
"broll_over_shoulder",
"broll_workspace",
"broll_closeup_process",
"broll_ambient",
"hook_shocked",
"hook_double_take",
"hook_wait_what",
"hook_excited_discovery",
"hook_caught_off_guard",
"hook_point_proof",
"hook_selfie_push_in",
"hook_strike_pose"
]
},
"videoSound": {
"type": "boolean"
},
"reviewFrames": {
"type": "boolean"
},
"videoDurationSeconds": {
"type": "number",
"enum": [
5,
10,
15,
20,
30
]
},
"talkingHeadSeconds": {
"type": "integer",
"minimum": 4,
"maximum": 30
},
"talkingHeadCut": {
"type": "string",
"enum": [
"product",
"creator"
]
},
"reuseSourceAudio": {
"type": "boolean"
},
"openingTextMode": {
"type": "string",
"enum": [
"generated",
"source",
"custom",
"none"
]
},
"openingText": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"showBefore": {
"type": "boolean"
},
"beforeAfter": {
"type": "boolean"
},
"productIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"shotTemplate": {
"type": "string",
"enum": [
"hero",
"try_on",
"lifestyle",
"unboxing"
]
},
"videoTreatment": {
"type": "string",
"enum": [
"ugc",
"cinematic"
]
},
"templateSlug": {
"type": "string",
"maxLength": 64
},
"savedTemplateId": {
"type": "string",
"format": "uuid"
},
"publishedTemplateId": {
"type": "string",
"format": "uuid"
},
"templateRun": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 4
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
},
"required": [
"index",
"count"
],
"additionalProperties": false
},
"templateFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 500
},
"propertyNames": {
"maxLength": 64
}
},
"soundLinks": {
"type": "object",
"properties": {
"tiktok": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"instagram": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"referenceMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"promptMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"photoReelSlotMs": {
"type": "integer",
"minimum": 230,
"maximum": 1000
},
"aspectRatio": {
"type": "string",
"enum": [
"9:16",
"4:5",
"1:1",
"4:3",
"16:9"
]
},
"photoCount": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"faceless": {
"type": "boolean"
},
"reshootFace": {
"type": "boolean"
}
},
"required": [
"format"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"workspaceId",
"brandName"
],
"additionalProperties": true
}update_content_textWrite
Update a private content item's caption, hashtags, or sound links. This costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
caption | No / conditional | stringmaxLength: 2000 |
hashtags | No / conditional | array |
soundLinks | No / conditional | object |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "update_content_text-example-1",
"caption": "A calmer desk starts here.",
"hashtags": [
"desksetup"
]
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"caption": {
"type": "string",
"maxLength": 2000
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"soundLinks": {
"type": "object",
"properties": {
"tiktok": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"instagram": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}create_uploaded_contentWrite
Create a private post from existing media IDs without generating new media or spending credits. Supports images and videos. Use upload tools first, then publish_content or schedule_post when ready.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
format | Yes | "slideshow" | "wall_of_text" | "video" | "green_screen" | "hook_demo" | "talking_head" | "photo_reel" |
influencerId | No / conditional | uuid |
targetAccountId | No / conditional | uuid |
caption | No / conditional | string |
soundLinks | No / conditional | object |
hashtags | No / conditional | array |
slides | Yes | arrayminItems: 1maxItems: 20 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"format": "slideshow",
"slides": [
{
"mediaId": "22222222-2222-4222-8222-222222222222"
}
],
"idempotency_key": "create_uploaded_content-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"influencerId": {
"type": "string",
"format": "uuid"
},
"targetAccountId": {
"type": "string",
"format": "uuid"
},
"caption": {
"type": "string"
},
"soundLinks": {
"type": "object",
"properties": {
"tiktok": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"instagram": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"const": "auto"
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
],
"default": null
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
{
"type": "null"
}
],
"default": null
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
{
"type": "null"
}
],
"default": null
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
],
"default": null
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
]
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"default": null
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
}
},
"required": [
"mediaId"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 20
}
},
"required": [
"format",
"slides"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt, slides, renderedUrl, renderedDurationMs, renderStale.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"slides": [],
"renderStale": false,
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale",
"workspaceId",
"brandName"
],
"additionalProperties": true
}save_content_slidesWrite
Save the complete ordered slide or video timeline, including layout, text overlays, trims, music, and media. Read get_content first and preserve fields the user did not ask to change. Video edits queue a render; wait for get_content to show the saved render before publishing.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
slides | Yes | arrayminItems: 1maxItems: 40 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"slides": [
{
"mediaId": "22222222-2222-4222-8222-222222222222",
"timelineDurationMs": null,
"label": null,
"mediaFrame": {
"x": 0.5,
"y": 0.5,
"zoom": 1
},
"trimInMs": null,
"trimOutMs": null,
"key": null
}
],
"idempotency_key": "save_content_slides-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
],
"default": "visual"
},
"trackIndex": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"default": 0
},
"timelineStartMs": {
"type": "integer",
"minimum": 0,
"default": 0
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 600
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"const": "auto"
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
],
"default": null
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
{
"type": "null"
}
],
"default": null
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
{
"type": "null"
}
],
"default": null
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
{
"type": "null"
}
],
"default": null
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
]
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"default": null
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
},
"maxItems": 5,
"default": []
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
],
"default": "full"
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
}
},
"required": [
"mediaId",
"frame"
],
"additionalProperties": false
},
"maxItems": 5,
"default": []
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame"
],
"additionalProperties": false
},
"maxItems": 4,
"default": []
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false,
"default": {
"x": 0,
"y": 0,
"width": 1,
"height": 1
}
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"volume": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"muted": {
"type": "boolean",
"default": false
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"key": {
"anyOf": [
{
"type": "object",
"properties": {
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"similarity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"blend": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"color",
"similarity",
"blend"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"timelineDurationMs",
"label",
"mediaFrame",
"trimInMs",
"trimOutMs",
"key"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 40
}
},
"required": [
"slides"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt, slides, renderedUrl, renderedDurationMs, renderStale.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"slides": [],
"renderStale": false,
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale",
"workspaceId",
"brandName"
],
"additionalProperties": true
}regenerate_content_textWrite
Rewrite a post's text in place with the user's direction. Costs 5 credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
prompt | No / conditional | stringmaxLength: 500 |
sellStyle | No / conditional | "none" | "soft" | "hard" |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "regenerate_content_text-example-1",
"prompt": "Make the opening shorter"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"prompt": {
"type": "string",
"maxLength": 500
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt, slides, renderedUrl, renderedDurationMs, renderStale.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"slides": [],
"renderStale": false,
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale",
"workspaceId",
"brandName"
],
"additionalProperties": true
}reroll_content_photosWrite
Replace an image post's photos using the existing library or selected media IDs. Costs no credits and generates no new photos.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
mediaIds | No / conditional | arraymaxItems: 5default: [] |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "reroll_content_photos-example-1",
"mediaIds": [
"22222222-2222-4222-8222-222222222222"
]
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5,
"default": []
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt, slides, renderedUrl, renderedDurationMs, renderStale.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"slides": [],
"renderStale": false,
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale",
"workspaceId",
"brandName"
],
"additionalProperties": true
}tweak_contentWrite
Create a revised version with the user's direction. Costs 5 credits, plus 5 per reserved fresh photo when photos=fresh. Background work returns a jobId for get_job. Keep both versions or use resolve_content_tweak to choose one.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
instruction | No / conditional | stringmaxLength: 500 |
photos | No / conditional | "library" | "fresh"default: "library" |
background | No / conditional | truedefault: true |
feedbackId | No / conditional | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "tweak_content-example-1",
"instruction": "Use a warmer tone",
"photos": "library",
"background": true
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"instruction": {
"type": "string",
"maxLength": 500
},
"photos": {
"type": "string",
"enum": [
"library",
"fresh"
],
"default": "library"
},
"background": {
"type": "boolean",
"const": true,
"default": true
},
"feedbackId": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status, creditCost.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"creditCost": 5,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"creditCost": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"creditCost",
"workspaceId",
"brandName"
],
"additionalProperties": true
}resolve_content_tweakWrite
Choose the old or new version after comparing a tweak. Pass the NEW version's content_id. Keeping both needs no call.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
keep | Yes | "new" | "old" |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"keep": "new",
"idempotency_key": "resolve_content_tweak-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"keep": {
"type": "string",
"enum": [
"new",
"old"
]
}
},
"required": [
"keep"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, targetAccountId, remixedFromId, remixSourceUrl, remixSkeletonId, tweakedFromId, savedTemplateId, format, origin, generationSource, status, sellStyle, caption, soundTiktokUrl, soundInstagramUrl, hashtags, angle, seed, learningContext, turboDeckRank, turboAutoDiscardedAt, renderedMediaId, renderedNoMusicMediaId, timelineRev, renderedRev, renderStatus, renderError, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"status": "draft",
"caption": "Example",
"renderStatus": "idle",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}multiply_contentWrite
Create variations of an image post, optionally for other influencers. Costs 5 credits per variation; replacing the source with influencer swaps costs 5 per reserved photo per influencer. Returns a jobId for get_job.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
mode | No / conditional | "influencers" | "raw"default: "influencers" |
targets | No / conditional | array |
count | No / conditional | integerminimum: 1maximum: 5 |
keepHook | No / conditional | booleandefault: true |
shuffleOrder | No / conditional | booleandefault: false |
varyColors | No / conditional | booleandefault: false |
replaceSource | No / conditional | booleandefault: false |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "multiply_content-example-1",
"mode": "raw",
"count": 2
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"influencers",
"raw"
],
"default": "influencers"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"influencerId": {
"type": "string",
"format": "uuid"
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
},
"required": [
"influencerId",
"count"
],
"additionalProperties": false
}
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"keepHook": {
"type": "boolean",
"default": true
},
"shuffleOrder": {
"type": "boolean",
"default": false
},
"varyColors": {
"type": "boolean",
"default": false
},
"replaceSource": {
"type": "boolean",
"default": false
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status, creditCost.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"creditCost": 10,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"creditCost": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"creditCost",
"workspaceId",
"brandName"
],
"additionalProperties": true
}improve_videoWrite
Improve a finished video's visuals without changing speech. Costs 16 credits per supported video second. Returns a jobId for get_job.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
instruction | Yes | stringminLength: 1maxLength: 500 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"instruction": "Clean up the background artifacts",
"idempotency_key": "improve_video-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {
"instruction": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"instruction"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status, creditCost.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"creditCost": 80,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"creditCost": {
"type": "integer"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"creditCost",
"workspaceId",
"brandName"
],
"additionalProperties": true
}download_contentWrite
Prepare signed downloads for a content item. Requires export access; no generation credits are spent.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
content_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"content_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "download_content-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"content_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"content_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: url, filename.
{
"url": "https://example.com/file",
"filename": "Example",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"filename": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"url",
"filename",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_templatesRead
Read saved Studio templates, favorites, and previews. Built-in template definitions are returned by get_studio_options.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: saved, favoriteSlugs, previews.
{
"saved": [],
"favoriteSlugs": [],
"previews": {},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"saved": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"parentSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoTemplate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"values": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 500
},
"default": {}
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"default": null
},
{
"type": "null"
}
]
},
"productIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 10,
"default": []
},
"promptMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5,
"default": []
},
"look": {
"anyOf": [
{
"type": "string",
"default": null
},
{
"type": "null"
}
]
},
"lookPrompt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000,
"default": null
},
{
"type": "null"
}
]
},
"brief": {
"anyOf": [
{
"type": "string",
"maxLength": 5000,
"default": null
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"remix": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"link"
]
},
"url": {
"type": "string",
"format": "uri"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"upload"
]
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"part": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"startSeconds",
"endSeconds"
],
"additionalProperties": false
}
},
"required": [
"kind",
"mediaIds"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"pasted"
]
}
},
"required": [
"kind"
],
"additionalProperties": false
}
]
},
"origin": {
"type": "string",
"enum": [
"scan",
"trend"
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram",
"x",
"web",
"upload",
"pasted"
]
},
"sourceType": {
"type": "string",
"enum": [
"carousel",
"video",
"image",
"article"
]
},
"photoCount": {
"type": "integer",
"minimum": 0
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"generationDurationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"hasText": {
"type": "boolean"
},
"hasAudio": {
"type": "boolean"
},
"sourceSound": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"format": "uri"
},
"viral": {
"type": "boolean"
}
},
"required": [
"title",
"url",
"viral"
],
"additionalProperties": false
},
"format": {
"type": "string",
"maxLength": 32
},
"hook": {
"type": "string",
"maxLength": 500
},
"hookOptions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500
},
"minItems": 1,
"maxItems": 3
},
"prompt": {
"type": "string",
"maxLength": 5000
},
"summary": {
"type": "string",
"maxLength": 1000
},
"skeleton": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"niche": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"seed",
"scraped"
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo"
]
},
"slideCount": {
"type": "integer",
"exclusiveMinimum": true,
"minimum": 0
},
"hookShape": {
"type": "string"
},
"voiceSignature": {
"type": "string"
},
"ctaSlot": {
"type": "string",
"enum": [
"parenthetical_in_hook",
"final_slide_winner",
"caption_only",
"none"
]
},
"slideSkeleton": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"hook",
"item",
"payoff"
]
},
"beat": {
"type": "string"
},
"microFormat": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sentences": {
"type": "integer",
"minimum": 0
},
"words": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "integer",
"minimum": 0
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"shot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasPrimarySubject": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"keepSourceMedia": {
"type": "boolean"
}
},
"required": [
"role",
"beat",
"microFormat",
"sentences",
"words",
"lines"
],
"additionalProperties": false
},
"minItems": 1
},
"hookShot": {
"anyOf": [
{
"type": "object",
"properties": {
"opening": {
"type": "string"
},
"closing": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"production": {
"type": "string",
"enum": [
"phone",
"produced"
]
}
},
"required": [
"opening",
"closing",
"production"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hookSeconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
{
"type": "null"
}
]
},
"subjectKind": {
"anyOf": [
{
"type": "string",
"enum": [
"animal",
"person",
"object"
]
},
{
"type": "null"
}
]
},
"sourceIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"dance",
"stunt",
"workout",
"walk",
"talk",
"demo",
"other"
],
"default": null
},
{
"type": "null"
}
]
},
"hasAudibleSpeech": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"screenshotOf": {
"anyOf": [
{
"type": "boolean",
"default": null
},
{
"type": "null"
}
]
},
"semanticBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
"visual": {
"type": "string"
},
"audioCue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"startSeconds",
"endSeconds",
"visual",
"audioCue"
],
"additionalProperties": false
}
},
"visualInserts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0
},
"anchorText": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"proof",
"example",
"product",
"joke",
"interface",
"other"
]
},
"kind": {
"type": "string",
"enum": [
"photo",
"illustration",
"screenshot",
"card"
]
},
"coverage": {
"type": "string",
"enum": [
"overlay",
"full"
]
},
"description": {
"type": "string",
"minLength": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"anchorText",
"role",
"kind",
"coverage",
"description",
"frame",
"entrance",
"exit"
],
"additionalProperties": false
},
"default": []
},
"overlayBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atSeconds": {
"type": "number"
},
"endSeconds": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"atSeconds",
"text"
],
"additionalProperties": false
}
},
"spokenWords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"overlayLook": {
"anyOf": [
{
"type": "object",
"properties": {
"background": {
"type": "string",
"enum": [
"box_light",
"box_dark",
"outline",
"none"
]
},
"position": {
"type": "string",
"enum": [
"top",
"middle",
"lower"
]
},
"textCase": {
"type": "string",
"enum": [
"lower",
"sentence",
"upper"
]
},
"textColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"backgroundColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
}
},
"required": [
"background",
"position",
"textCase"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cuts": {
"type": "array",
"items": {
"type": "number"
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"whatChanges": {
"type": "string"
},
"hasPrimarySubject": {
"type": "boolean"
}
},
"required": [
"whatChanges",
"hasPrimarySubject"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"niche",
"source",
"format",
"slideCount",
"hookShape",
"voiceSignature",
"ctaSlot",
"slideSkeleton",
"hookShot",
"hookSeconds",
"durationSeconds",
"subjectKind",
"semanticBeats",
"overlayBeats",
"cuts",
"shots"
],
"additionalProperties": false
},
"previewMediaIds": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"analysisToken": {
"type": "string"
}
},
"required": [
"source",
"origin",
"platform",
"sourceType",
"photoCount",
"durationSeconds",
"generationDurationSeconds",
"hasText",
"hasAudio",
"format",
"hook",
"hookOptions",
"prompt",
"summary",
"skeleton",
"analysisToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"favorite": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"sharedId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"preview": {
"anyOf": [
{
"type": "object",
"properties": {
"posterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"clipUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"posterUrl",
"clipUrl"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"parentSlug",
"format",
"videoTemplate",
"values",
"remix",
"favorite",
"createdAt",
"sharedId",
"preview"
],
"additionalProperties": false
}
},
"favoriteSlugs": {
"type": "array",
"items": {
"type": "string"
}
},
"previews": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"posterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"clipUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"posterUrl",
"clipUrl"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"saved",
"favoriteSlugs",
"previews",
"workspaceId",
"brandName"
],
"additionalProperties": true
}estimate_content_costRead
Estimate the maximum credits reserved for a Content Studio generation request before creating it. Actual cost can be lower for a influencer's included first face shoot or reused media. No content is created and no credits are spent.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
format | Yes | "slideshow" | "wall_of_text" | "video" | "green_screen" | "hook_demo" | "talking_head" | "photo_reel" |
influencerId | No / conditional | uuid |
personaMediaId | No / conditional | uuid |
matchPersonaPhoto | No / conditional | boolean |
targetAccountId | No / conditional | uuid |
prompt | No / conditional | stringminLength: 1 |
imageSource | No / conditional | "fresh" | "auto" | "manual"default: "fresh" |
mediaIds | No / conditional | array |
hookMediaId | No / conditional | uuid |
hookVideoPrompt | No / conditional | stringminLength: 1 |
demoMediaId | No / conditional | uuid |
memeTemplateMediaId | No / conditional | uuid |
backgroundMediaId | No / conditional | uuid |
remixAnalysisToken | No / conditional | stringminLength: 1 |
remixSkeleton | No / conditional | object |
creatorSwap | No / conditional | boolean |
keepSourceSlideIndexes | No / conditional | arraymaxItems: 10 |
remixScanId | No / conditional | stringminLength: 1maxLength: 64 |
mode | No / conditional | "content" | "photos" | "videos"default: "content" |
videoTemplate | No / conditional | "product_faceless_clean_hero" | "product_faceless_pick_up" | "product_faceless_turn_inspect" | "product_faceless_open_close" | "product_faceless_use" | "product_faceless_macro" | "product_creator_present" | "product_creator_use" | "product_creator_try_apply" | "product_creator_unbox" | "product_creator_inspect" | "product_creator_hold_camera" | "broll_hands_work" | "broll_pov_action" | "broll_over_shoulder" | "broll_workspace" | "broll_closeup_process" | "broll_ambient" | "hook_shocked" | "hook_double_take" | "hook_wait_what" | "hook_excited_discovery" | "hook_caught_off_guard" | "hook_point_proof" | "hook_selfie_push_in" | "hook_strike_pose" |
videoSound | No / conditional | boolean |
reviewFrames | No / conditional | boolean |
videoDurationSeconds | No / conditional | 5 | 10 | 15 | 20 | 30 |
talkingHeadSeconds | No / conditional | integerminimum: 4maximum: 30 |
talkingHeadCut | No / conditional | "product" | "creator" |
reuseSourceAudio | No / conditional | boolean |
openingTextMode | No / conditional | "generated" | "source" | "custom" | "none" |
openingText | No / conditional | stringminLength: 1maxLength: 500 |
showBefore | No / conditional | boolean |
beforeAfter | No / conditional | boolean |
productIds | No / conditional | array |
shotTemplate | No / conditional | "hero" | "try_on" | "lifestyle" | "unboxing" |
videoTreatment | No / conditional | "ugc" | "cinematic" |
templateSlug | No / conditional | stringmaxLength: 64 |
savedTemplateId | No / conditional | uuid |
publishedTemplateId | No / conditional | uuid |
templateRun | No / conditional | object |
templateFields | No / conditional | object |
soundLinks | No / conditional | object |
referenceMediaIds | No / conditional | arraymaxItems: 5 |
promptMediaIds | No / conditional | arraymaxItems: 5 |
photoReelSlotMs | No / conditional | integerminimum: 230maximum: 1000 |
aspectRatio | No / conditional | "9:16" | "4:5" | "1:1" | "4:3" | "16:9" |
photoCount | No / conditional | integerminimum: 1maximum: 5 |
faceless | No / conditional | boolean |
reshootFace | No / conditional | boolean |
Input example
{
"format": "slideshow",
"mode": "content",
"prompt": "Three ways to keep a desk tidy",
"imageSource": "fresh"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"influencerId": {
"type": "string",
"format": "uuid"
},
"personaMediaId": {
"type": "string",
"format": "uuid"
},
"matchPersonaPhoto": {
"type": "boolean"
},
"targetAccountId": {
"type": "string",
"format": "uuid"
},
"prompt": {
"type": "string",
"minLength": 1
},
"imageSource": {
"type": "string",
"enum": [
"fresh",
"auto",
"manual"
],
"default": "fresh"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"hookMediaId": {
"type": "string",
"format": "uuid"
},
"hookVideoPrompt": {
"type": "string",
"minLength": 1
},
"demoMediaId": {
"type": "string",
"format": "uuid"
},
"memeTemplateMediaId": {
"type": "string",
"format": "uuid"
},
"backgroundMediaId": {
"type": "string",
"format": "uuid"
},
"remixAnalysisToken": {
"type": "string",
"minLength": 1
},
"remixSkeleton": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"niche": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"seed",
"scraped"
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo"
]
},
"slideCount": {
"type": "integer",
"exclusiveMinimum": 0
},
"hookShape": {
"type": "string"
},
"voiceSignature": {
"type": "string"
},
"ctaSlot": {
"type": "string",
"enum": [
"parenthetical_in_hook",
"final_slide_winner",
"caption_only",
"none"
]
},
"slideSkeleton": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"hook",
"item",
"payoff"
]
},
"beat": {
"type": "string"
},
"microFormat": {
"type": [
"string",
"null"
]
},
"sentences": {
"type": "integer",
"minimum": 0
},
"words": {
"type": "integer",
"minimum": 0
},
"lines": {
"type": "integer",
"minimum": 0
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"shot": {
"type": [
"string",
"null"
]
},
"hasPrimarySubject": {
"type": [
"boolean",
"null"
]
},
"keepSourceMedia": {
"type": "boolean"
}
},
"required": [
"role",
"beat",
"microFormat",
"sentences",
"words",
"lines"
],
"additionalProperties": false
},
"minItems": 1
},
"hookShot": {
"anyOf": [
{
"type": "object",
"properties": {
"opening": {
"type": "string"
},
"closing": {
"type": [
"string",
"null"
]
},
"production": {
"type": "string",
"enum": [
"phone",
"produced"
]
}
},
"required": [
"opening",
"closing",
"production"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hookSeconds": {
"type": [
"number",
"null"
]
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"subjectKind": {
"anyOf": [
{
"type": "string",
"enum": [
"animal",
"person",
"object"
]
},
{
"type": "null"
}
]
},
"sourceIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"dance",
"stunt",
"workout",
"walk",
"talk",
"demo",
"other"
]
},
{
"type": "null"
}
],
"default": null
},
"hasAudibleSpeech": {
"type": [
"boolean",
"null"
]
},
"screenshotOf": {
"type": [
"boolean",
"null"
],
"default": null
},
"semanticBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"visual": {
"type": "string"
},
"audioCue": {
"type": [
"string",
"null"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"visual",
"audioCue"
],
"additionalProperties": false
}
},
"visualInserts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startSeconds": {
"type": "number",
"minimum": 0
},
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"anchorText": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"role": {
"type": "string",
"enum": [
"proof",
"example",
"product",
"joke",
"interface",
"other"
]
},
"kind": {
"type": "string",
"enum": [
"photo",
"illustration",
"screenshot",
"card"
]
},
"coverage": {
"type": "string",
"enum": [
"overlay",
"full"
]
},
"description": {
"type": "string",
"minLength": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"startSeconds",
"endSeconds",
"anchorText",
"role",
"kind",
"coverage",
"description",
"frame",
"entrance",
"exit"
],
"additionalProperties": false
},
"default": []
},
"overlayBeats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atSeconds": {
"type": "number"
},
"endSeconds": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"atSeconds",
"text"
],
"additionalProperties": false
}
},
"spokenWords": {
"type": [
"string",
"null"
]
},
"overlayLook": {
"anyOf": [
{
"type": "object",
"properties": {
"background": {
"type": "string",
"enum": [
"box_light",
"box_dark",
"outline",
"none"
]
},
"position": {
"type": "string",
"enum": [
"top",
"middle",
"lower"
]
},
"textCase": {
"type": "string",
"enum": [
"lower",
"sentence",
"upper"
]
},
"textColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"backgroundColor": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
}
},
"required": [
"background",
"position",
"textCase"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cuts": {
"type": "array",
"items": {
"type": "number"
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"whatChanges": {
"type": "string"
},
"hasPrimarySubject": {
"type": "boolean"
}
},
"required": [
"whatChanges",
"hasPrimarySubject"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"niche",
"source",
"format",
"slideCount",
"hookShape",
"voiceSignature",
"ctaSlot",
"slideSkeleton",
"hookShot",
"hookSeconds",
"durationSeconds",
"subjectKind",
"semanticBeats",
"overlayBeats",
"cuts",
"shots"
],
"additionalProperties": false
},
"creatorSwap": {
"type": "boolean"
},
"keepSourceSlideIndexes": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"maxItems": 10
},
"remixScanId": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"mode": {
"type": "string",
"enum": [
"content",
"photos",
"videos"
],
"default": "content"
},
"videoTemplate": {
"type": "string",
"enum": [
"product_faceless_clean_hero",
"product_faceless_pick_up",
"product_faceless_turn_inspect",
"product_faceless_open_close",
"product_faceless_use",
"product_faceless_macro",
"product_creator_present",
"product_creator_use",
"product_creator_try_apply",
"product_creator_unbox",
"product_creator_inspect",
"product_creator_hold_camera",
"broll_hands_work",
"broll_pov_action",
"broll_over_shoulder",
"broll_workspace",
"broll_closeup_process",
"broll_ambient",
"hook_shocked",
"hook_double_take",
"hook_wait_what",
"hook_excited_discovery",
"hook_caught_off_guard",
"hook_point_proof",
"hook_selfie_push_in",
"hook_strike_pose"
]
},
"videoSound": {
"type": "boolean"
},
"reviewFrames": {
"type": "boolean"
},
"videoDurationSeconds": {
"type": "number",
"enum": [
5,
10,
15,
20,
30
]
},
"talkingHeadSeconds": {
"type": "integer",
"minimum": 4,
"maximum": 30
},
"talkingHeadCut": {
"type": "string",
"enum": [
"product",
"creator"
]
},
"reuseSourceAudio": {
"type": "boolean"
},
"openingTextMode": {
"type": "string",
"enum": [
"generated",
"source",
"custom",
"none"
]
},
"openingText": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"showBefore": {
"type": "boolean"
},
"beforeAfter": {
"type": "boolean"
},
"productIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"shotTemplate": {
"type": "string",
"enum": [
"hero",
"try_on",
"lifestyle",
"unboxing"
]
},
"videoTreatment": {
"type": "string",
"enum": [
"ugc",
"cinematic"
]
},
"templateSlug": {
"type": "string",
"maxLength": 64
},
"savedTemplateId": {
"type": "string",
"format": "uuid"
},
"publishedTemplateId": {
"type": "string",
"format": "uuid"
},
"templateRun": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 4
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
},
"required": [
"index",
"count"
],
"additionalProperties": false
},
"templateFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 500
},
"propertyNames": {
"maxLength": 64
}
},
"soundLinks": {
"type": "object",
"properties": {
"tiktok": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"instagram": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"referenceMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"promptMediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 5
},
"photoReelSlotMs": {
"type": "integer",
"minimum": 230,
"maximum": 1000
},
"aspectRatio": {
"type": "string",
"enum": [
"9:16",
"4:5",
"1:1",
"4:3",
"16:9"
]
},
"photoCount": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"faceless": {
"type": "boolean"
},
"reshootFace": {
"type": "boolean"
}
},
"required": [
"format"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: maximumCreditCost.
{
"maximumCreditCost": 30,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"maximumCreditCost": {
"description": "See the example for this returned field.",
"type": "number"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_templateRead
Read one built-in Studio template, including its fields, defaults, and generation settings. Pass its slug from get_studio_options.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
slug | Yes | stringminLength: 1maxLength: 64 |
Input example
{
"slug": "corner_reaction"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"slug"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: template.
{
"template": {
"slug": "corner_reaction",
"name": "Corner Reaction",
"description": "Your creator reacts in the corner while the original video keeps playing.",
"group": "hook",
"listed": true,
"format": "green_screen",
"seconds": 15,
"scenes": 1,
"controls": [],
"source": {
"label": "Which video do you want to react to?",
"hint": "Paste a link or upload the clip. Its real timing and cuts stay in place."
},
"sourceAsBackground": true,
"fields": [
{
"key": "caption",
"label": "Words on screen",
"placeholder": "one short line, held for the whole clip",
"prefill": "nobody tells you this part",
"omittable": true,
"maxLength": 90
}
],
"overlayTemplate": "outlined",
"briefTemplate": "On-screen text: {caption}"
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"template": {
"description": "See the example for this returned field.",
"type": "object"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_studio_optionsRead
Read Studio formats, image/video options, built-in template settings and fields, credit rates, and the current consent version before creating content. Use create_content with the same settings Studio accepts.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: formats, modes, videoTemplates, photoAspectRatios, creditCosts, consentVersion, consentPurposes, templates.
{
"formats": [
{
"format": "slideshow",
"label": "Slideshow",
"kind": "image"
},
{
"format": "wall_of_text",
"label": "Wall of text",
"kind": "image"
},
{
"format": "video",
"label": "Video",
"kind": "video"
},
{
"format": "green_screen",
"label": "Green screen",
"kind": "video"
},
{
"format": "hook_demo",
"label": "Hook & demo",
"kind": "video"
},
{
"format": "talking_head",
"label": "Talking head",
"kind": "video"
},
{
"format": "photo_reel",
"label": "Photo reel",
"kind": "video"
}
],
"modes": [
"content",
"photos",
"videos"
],
"videoTemplates": [
"product_faceless_clean_hero",
"product_faceless_pick_up",
"product_faceless_turn_inspect",
"product_faceless_open_close",
"product_faceless_use",
"product_faceless_macro",
"product_creator_present",
"product_creator_use",
"product_creator_try_apply",
"product_creator_unbox",
"product_creator_inspect",
"product_creator_hold_camera",
"broll_hands_work",
"broll_pov_action",
"broll_over_shoulder",
"broll_workspace",
"broll_closeup_process",
"broll_ambient",
"hook_shocked",
"hook_double_take",
"hook_wait_what",
"hook_excited_discovery",
"hook_caught_off_guard",
"hook_point_proof",
"hook_selfie_push_in",
"hook_strike_pose"
],
"photoAspectRatios": [
"9:16",
"4:5",
"1:1",
"4:3",
"16:9"
],
"creditCosts": {
"nicheScan": 20,
"extraIdeas": 15,
"extraVideos": 25,
"reroll": 5,
"videoPerSecond": 16,
"talkingHeadPerSecond": 20,
"creator": 125,
"improvePhoto": 1,
"photo": 5,
"post": 5,
"connection": 100,
"extraBrand": 300,
"warmedAccount": 2000
},
"consentVersion": "2026-07-28",
"consentPurposes": [
"biometric_reference_face",
"biometric_voice_clone"
],
"templates": [
{
"slug": "corner_reaction",
"name": "Corner Reaction",
"description": "Your creator reacts in the corner while the original video keeps playing.",
"format": "green_screen"
},
{
"slug": "strike_pose",
"name": "Strike the pose",
"description": "Arms up behind the head, then down as they keep talking.",
"format": "talking_head"
},
{
"slug": "selfie_push_in",
"name": "Selfie Push-In + Caption",
"description": "Slow move closer while the words carry it.",
"format": "video"
},
{
"slug": "shocked",
"name": "Shocked",
"description": "A fast silent gasp, straight off the top.",
"format": "video"
},
{
"slug": "double_take",
"name": "Double take",
"description": "Snap back to the camera and lean in.",
"format": "video"
},
{
"slug": "wait_what",
"name": "Wait, what?",
"description": "One sharp skeptical look that asks the question for you.",
"format": "video"
},
{
"slug": "excited_discovery",
"name": "Excited discovery",
"description": "Light up and gesture like you just found it.",
"format": "video"
},
{
"slug": "caught_off_guard",
"name": "Caught off guard",
"description": "Freeze at the camera as if it started early.",
"format": "video"
},
{
"slug": "point_proof",
"name": "Point to the proof",
"description": "Point into empty space and let the words fill it.",
"format": "video"
},
{
"slug": "action_loop",
"name": "Action Loop + Caption",
"description": "One action, filmed as a single take, with a line held over it.",
"format": "video"
},
{
"slug": "dance_copy",
"name": "Dance Motion-Copy",
"description": "Paste a dance and your creator does it, wherever you put them.",
"format": "video"
},
{
"slug": "disco_dance",
"name": "Disco Dance",
"description": "Dancing under coloured lights, one line held over the whole thing.",
"format": "video"
},
{
"slug": "beach_dance",
"name": "Beach Dance",
"description": "Copy a dance onto your creator on a bright beach, with one caption above.",
"format": "video"
},
{
"slug": "motivation_run",
"name": "Motivation run",
"description": "Out running, filmed from the front, with the reason on screen.",
"format": "video"
},
{
"slug": "number_contrast",
"name": "Number contrast",
"description": "Two things side by side with their numbers, so the gap does the talking.",
"format": "video"
},
{
"slug": "sound_sync_pov",
"name": "Lip-Sync To Audio",
"description": "Your creator lip-syncs a clip you choose, close to camera, with one caption above.",
"format": "talking_head"
},
{
"slug": "one_line_held",
"name": "One-Line Meme Clip",
"description": "One short line, held over the whole clip.",
"format": "video"
},
{
"slug": "day_count",
"name": "Day Counter Clip",
"description": "A day number and the thing you are keeping up, like a streak.",
"format": "video"
},
{
"slug": "one_rule",
"name": "Animated Rule Card",
"description": "One rule, said flat, with nothing softening it.",
"format": "wall_of_text"
},
{
"slug": "step_plan",
"name": "Workout Plan Text",
"description": "A plan, one step to a line, in the order you would do them.",
"format": "video"
},
{
"slug": "numbered_list",
"name": "Beginner Listicle",
"description": "A hook, then five numbered points, one to a clip.",
"format": "photo_reel"
},
{
"slug": "review_verdict",
"name": "Sectioned Review",
"description": "Five clips: hook, subject, facts, verdict, and what comes next.",
"format": "photo_reel"
},
{
"slug": "screenshot_post",
"name": "Fake Instagram Post",
"description": "Written to look like a screenshot of a post somebody wrote.",
"format": "wall_of_text"
},
{
"slug": "story_notification",
"name": "Story + notification",
"description": "A photo that starts the story, then a message with your app's reminder below it.",
"format": "slideshow"
},
{
"slug": "superhero_swing",
"name": "Human Superhero Swing",
"description": "Swinging between rooftops over the city, filmed from below like a stunt.",
"format": "video"
},
{
"slug": "pet_superhero_swing",
"name": "Pet Superhero Swing",
"description": "Your own pet somewhere ordinary, then swinging on a line through the city.",
"format": "video"
},
{
"slug": "slime_asmr",
"name": "Slime ASMR Loop",
"description": "Hands working slime, close and slow, with nothing else in frame.",
"format": "video"
},
{
"slug": "comfort_creature",
"name": "Silent ASMR Loop",
"description": "A small creature breathing in the dark, on a loop.",
"format": "video"
},
{
"slug": "reaction_face_swap",
"name": "Reaction Face-Swap",
"description": "Put your creator into the reaction beats of a clip you choose.",
"format": "video"
},
{
"slug": "green_screen_overlay",
"name": "Green-Screen Overlay",
"description": "Key a green-screen character over your own background with one caption above.",
"format": "green_screen"
},
{
"slug": "build_timelapse",
"name": "Build Timelapse",
"description": "Watch one thing take shape from an empty start to the finished build.",
"format": "video"
},
{
"slug": "anatomy_workout",
"name": "Exercise + Anatomy Overlay",
"description": "Show each exercise with the working muscle called out beside it.",
"format": "video"
},
{
"slug": "even_cut_reel",
"name": "Photo reel",
"description": "Your own photos, cut fast to one line. Nothing is generated.",
"format": "photo_reel"
},
{
"slug": "flash_montage",
"name": "Flash-Cut Montage",
"description": "As fast as it goes, with one line held right through it.",
"format": "photo_reel"
}
],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"formats": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"modes": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"videoTemplates": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"photoAspectRatios": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"creditCosts": {
"description": "See the example for this returned field.",
"type": "object"
},
"consentVersion": {
"description": "See the example for this returned field.",
"type": "string"
},
"consentPurposes": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"templates": {
"description": "See the example for this returned field.",
"type": "array",
"items": {}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"workspaceId",
"brandName"
],
"additionalProperties": true
}Scheduling and publishing
schedule_postWrite
Schedule a private content item through an existing social account. This costs no credits and can be cancelled before posting.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
intentSource | No / conditional | "explicit" | "remembered" |
contentItemId | Yes | uuid |
accountId | Yes | uuid |
caption | No / conditional | string | null |
hashtags | No / conditional | array | null |
isPaidPartnership | No / conditional | boolean |
mediaAiDeclarations | No / conditional | arraymaxItems: 20 |
when | Yes | stringpattern: "^\\d{4}-\\d{2}-\\d{2}$" |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"when": "2026-10-15",
"idempotency_key": "schedule_post-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"intentSource": {
"type": "string",
"enum": [
"explicit",
"remembered"
]
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 2200
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isPaidPartnership": {
"type": "boolean"
},
"mediaAiDeclarations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"isAiGenerated": {
"type": "boolean"
}
},
"required": [
"mediaId",
"isAiGenerated"
],
"additionalProperties": false
},
"maxItems": 20
},
"when": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"contentItemId",
"accountId",
"when"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, contentItemId, accountId, status, publishJobId, runAt, postedAt, externalUrl, externalId, failureCode, failureMessage, caption, hashtags, isAigc, isPaidPartnership, views, likes, comments, saves, metricsSyncedAt, learningEligible, learningExclusionReason, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"status": "scheduled",
"postedAt": null,
"externalUrl": null,
"caption": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}reschedule_postWrite
Move a scheduled post to another day. This costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
post_id | Yes | uuid |
when | Yes | stringpattern: "^\\d{4}-\\d{2}-\\d{2}$" |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"post_id": "11111111-1111-4111-8111-111111111111",
"when": "2026-10-16",
"idempotency_key": "reschedule_post-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"post_id": {
"type": "string",
"format": "uuid"
},
"when": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"post_id",
"when"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, contentItemId, accountId, status, publishJobId, runAt, postedAt, externalUrl, externalId, failureCode, failureMessage, caption, hashtags, isAigc, isPaidPartnership, views, likes, comments, saves, metricsSyncedAt, learningEligible, learningExclusionReason, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"status": "scheduled",
"postedAt": null,
"externalUrl": null,
"caption": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}cancel_postWrite
Cancel a scheduled post before it reaches the public internet. This costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
post_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"post_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "cancel_post-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"post_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"post_id"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, contentItemId, accountId, status, publishJobId, runAt, postedAt, externalUrl, externalId, failureCode, failureMessage, caption, hashtags, isAigc, isPaidPartnership, views, likes, comments, saves, metricsSyncedAt, learningEligible, learningExclusionReason, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "11111111-1111-4111-8111-111111111111",
"status": "canceled",
"postedAt": "2026-10-02T00:00:00.000Z",
"externalUrl": "Example",
"caption": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_calendarRead
Read scheduled posts for a month or date range.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
month | No / conditional | stringpattern: "^\\d{4}-\\d{2}$" |
from | No / conditional | date-time |
to | No / conditional | date-time |
Input example
{
"month": "2026-10"
}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"month": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: result.
{
"result": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"runDay": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"coverUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"platform",
"handle",
"kind",
"country",
"runDay",
"format",
"coverUrl",
"renderedUrl"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"result",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_insightsRead
Read workspace performance and learning, optionally for one account.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
accountId | No / conditional | uuid |
Input example
{}Full input schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: sampleSize, minimumSampleSize, active, totals, lastWeek, perPlatform, perFormat, perAngle, topPosts, topFormat, topAngle, learning.
{
"sampleSize": 0,
"active": false,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"sampleSize": {
"type": "number"
},
"minimumSampleSize": {
"type": "number"
},
"active": {
"type": "boolean"
},
"totals": {
"type": "object",
"properties": {
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
}
},
"required": [
"views",
"likes",
"comments"
],
"additionalProperties": false
},
"lastWeek": {
"type": "object",
"properties": {
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
}
},
"required": [
"views",
"likes",
"comments"
],
"additionalProperties": false
},
"perPlatform": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string"
},
"posts": {
"type": "number"
},
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
}
},
"required": [
"platform",
"posts",
"views",
"likes",
"comments"
],
"additionalProperties": false
}
},
"perFormat": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"posts": {
"type": "number"
},
"engagement": {
"type": "number"
},
"avgEngagement": {
"type": "number"
}
},
"required": [
"key",
"posts",
"engagement",
"avgEngagement"
],
"additionalProperties": false
}
},
"perAngle": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"posts": {
"type": "number"
},
"engagement": {
"type": "number"
},
"avgEngagement": {
"type": "number"
}
},
"required": [
"key",
"posts",
"engagement",
"avgEngagement"
],
"additionalProperties": false
}
},
"topPosts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contentItemId": {
"type": "string"
},
"platform": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
}
},
"required": [
"contentItemId",
"platform",
"caption",
"views",
"likes",
"comments"
],
"additionalProperties": false
}
},
"topFormat": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"topAngle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"learning": {
"anyOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"evidence": {
"type": "integer"
},
"confidence": {
"type": "string",
"enum": [
"observing",
"early",
"established"
]
},
"explorationRate": {
"type": "number"
},
"format": {
"anyOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"evidence": {
"type": "integer"
},
"reachLift": {
"type": "number"
},
"engagementRatio": {
"type": "number"
},
"adjustmentPoints": {
"type": "number"
},
"dismissed": {
"type": "boolean"
}
},
"required": [
"key",
"evidence",
"reachLift",
"engagementRatio",
"adjustmentPoints",
"dismissed"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"angle": {
"anyOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"evidence": {
"type": "integer"
},
"reachLift": {
"type": "number"
},
"engagementRatio": {
"type": "number"
},
"adjustmentPoints": {
"type": "number"
},
"dismissed": {
"type": "boolean"
}
},
"required": [
"key",
"evidence",
"reachLift",
"engagementRatio",
"adjustmentPoints",
"dismissed"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"chosenFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"progress": {
"type": "object",
"properties": {
"posts": {
"type": "integer"
},
"mature": {
"type": "boolean"
},
"initialMedian": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"latestMedian": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"changePct": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"engagementChangePct": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"posts",
"mature",
"initialMedian",
"latestMedian",
"changePct",
"engagementChangePct"
],
"additionalProperties": false
},
"checkpointCoverage": {
"type": "object",
"properties": {
"24h": {
"type": "object",
"properties": {
"eligible": {
"type": "integer"
},
"captured": {
"type": "integer"
},
"pct": {
"type": "number"
}
},
"required": [
"eligible",
"captured",
"pct"
],
"additionalProperties": false
},
"7d": {
"type": "object",
"properties": {
"eligible": {
"type": "integer"
},
"captured": {
"type": "integer"
},
"pct": {
"type": "number"
}
},
"required": [
"eligible",
"captured",
"pct"
],
"additionalProperties": false
}
},
"required": [
"24h",
"7d"
],
"additionalProperties": false
}
},
"required": [
"accountId",
"platform",
"enabled",
"scope",
"checkpoint",
"evidence",
"confidence",
"explorationRate",
"format",
"angle",
"chosenFormatMix",
"effectiveFormatMix",
"progress",
"checkpointCoverage"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"sampleSize",
"minimumSampleSize",
"active",
"totals",
"lastWeek",
"perPlatform",
"perFormat",
"perAngle",
"topPosts",
"topFormat",
"topAngle",
"learning",
"workspaceId",
"brandName"
],
"additionalProperties": true
}publish_contentWrite
Publish a content item NOW through an already connected account. It queues public posting, not a private preview, and is not a guarantee of successful delivery. Use only when the user asks to publish; inspect the calendar for results. Confirm uploaded-media AI disclosure using mediaAiDeclarations. Costs no credits.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
intentSource | No / conditional | "explicit" | "remembered" |
contentItemId | Yes | uuid |
accountId | Yes | uuid |
caption | No / conditional | string | null |
hashtags | No / conditional | array | null |
isPaidPartnership | No / conditional | boolean |
mediaAiDeclarations | No / conditional | arraymaxItems: 20 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"idempotency_key": "publish_content-example-1",
"mediaAiDeclarations": [
{
"mediaId": "22222222-2222-4222-8222-222222222222",
"isAiGenerated": false
}
]
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"intentSource": {
"type": "string",
"enum": [
"explicit",
"remembered"
]
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 2200
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isPaidPartnership": {
"type": "boolean"
},
"mediaAiDeclarations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"isAiGenerated": {
"type": "boolean"
}
},
"required": [
"mediaId",
"isAiGenerated"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"contentItemId",
"accountId"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, contentItemId, accountId, status, publishJobId, runAt, postedAt, externalUrl, externalId, failureCode, failureMessage, caption, hashtags, isAigc, isPaidPartnership, views, likes, comments, saves, metricsSyncedAt, learningEligible, learningExclusionReason, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"status": "scheduled",
"postedAt": null,
"externalUrl": null,
"caption": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}publish_scheduled_postWrite
Move an existing post to publish NOW, or retry a failed post. It queues public posting. Use only when the user asks to publish or retry, then inspect the calendar for results.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
post_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"post_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "publish_scheduled_post-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"post_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"post_id"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, contentItemId, accountId, status, publishJobId, runAt, postedAt, externalUrl, externalId, failureCode, failureMessage, caption, hashtags, isAigc, isPaidPartnership, views, likes, comments, saves, metricsSyncedAt, learningEligible, learningExclusionReason, createdAt, updatedAt.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "33333333-3333-4333-8333-333333333333",
"status": "scheduled",
"postedAt": null,
"externalUrl": null,
"caption": "Example",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}post_own_fileWrite
Publish NOW or schedule the user's uploaded image(s) or single finished video through a connected account. First prepare_media_upload, upload the actual bytes, and complete_media_upload; pass the returned media_ids here. Explicitly ask whether uploaded media is AI-generated and supply mediaAiDeclarations. Requires when=now or a calendar day. Creates a post without generation credits. If scheduling fails, the error contains the saved content ID so it can be scheduled without re-uploading.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
format | Yes | "slideshow" | "wall_of_text" | "video" |
media_ids | Yes | arrayminItems: 1maxItems: 20 |
account_id | Yes | uuid |
when | Yes | "now" | string |
caption | No / conditional | string | null |
hashtags | No / conditional | array | null |
isPaidPartnership | No / conditional | boolean |
mediaAiDeclarations | No / conditional | arraymaxItems: 20 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"format": "slideshow",
"media_ids": [
"22222222-2222-4222-8222-222222222222"
],
"account_id": "33333333-3333-4333-8333-333333333333",
"when": "2026-10-15",
"idempotency_key": "post_own_file-example-1",
"caption": "Our new desk setup",
"mediaAiDeclarations": [
{
"mediaId": "22222222-2222-4222-8222-222222222222",
"isAiGenerated": false
}
]
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video"
]
},
"media_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"maxItems": 20
},
"account_id": {
"type": "string",
"format": "uuid"
},
"when": {
"anyOf": [
{
"type": "string",
"const": "now"
},
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
]
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 2200
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isPaidPartnership": {
"type": "boolean"
},
"mediaAiDeclarations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"isAiGenerated": {
"type": "boolean"
}
},
"required": [
"mediaId",
"isAiGenerated"
],
"additionalProperties": false
},
"maxItems": 20
}
},
"required": [
"format",
"media_ids",
"account_id",
"when"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: content, post.
{
"content": {
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"influencerId": "11111111-1111-4111-8111-111111111111",
"targetAccountId": "11111111-1111-4111-8111-111111111111",
"remixedFromId": "11111111-1111-4111-8111-111111111111",
"remixSourceUrl": "Example",
"remixSkeletonId": "Example",
"tweakedFromId": "11111111-1111-4111-8111-111111111111",
"savedTemplateId": "11111111-1111-4111-8111-111111111111",
"format": "slideshow",
"origin": "studio",
"generationSource": "studio",
"status": "draft",
"sellStyle": "none",
"caption": "Example",
"soundTiktokUrl": "Example",
"soundInstagramUrl": "Example",
"hashtags": [],
"angle": "Example",
"seed": "Example",
"learningContext": {
"scope": "account",
"checkpoint": "24h",
"experimental": false,
"reasons": [],
"effectiveFormatMix": {},
"effectiveAngleWeights": {}
},
"turboDeckRank": 0,
"turboAutoDiscardedAt": "2026-10-02T00:00:00.000Z",
"renderedMediaId": "11111111-1111-4111-8111-111111111111",
"renderedNoMusicMediaId": "11111111-1111-4111-8111-111111111111",
"timelineRev": 0,
"renderedRev": 0,
"renderStatus": "idle",
"renderError": "Example",
"createdAt": "2026-10-02T00:00:00.000Z",
"updatedAt": "2026-10-02T00:00:00.000Z",
"slides": [],
"renderedUrl": "Example",
"renderedDurationMs": 0,
"renderStale": false
},
"post": {
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"contentItemId": "11111111-1111-4111-8111-111111111111",
"accountId": "11111111-1111-4111-8111-111111111111",
"status": "scheduled",
"publishJobId": "11111111-1111-4111-8111-111111111111",
"runAt": "2026-10-02T00:00:00.000Z",
"postedAt": null,
"externalUrl": null,
"externalId": "Example",
"failureCode": "Example",
"failureMessage": "Example",
"caption": "Example",
"hashtags": [],
"isAigc": false,
"isPaidPartnership": false,
"views": 0,
"likes": 0,
"comments": 0,
"saves": 0,
"metricsSyncedAt": "2026-10-02T00:00:00.000Z",
"learningEligible": false,
"learningExclusionReason": "paid_or_boosted",
"createdAt": "2026-10-02T00:00:00.000Z",
"updatedAt": "2026-10-02T00:00:00.000Z"
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"targetAccountId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"remixSourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remixSkeletonId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tweakedFromId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"savedTemplateId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"format": {
"type": "string",
"enum": [
"slideshow",
"wall_of_text",
"video",
"green_screen",
"hook_demo",
"talking_head",
"photo_reel"
]
},
"origin": {
"type": "string",
"enum": [
"studio",
"turbo"
]
},
"generationSource": {
"type": "string",
"enum": [
"studio",
"turbo",
"face_swap",
"multiply",
"tweak",
"upload",
"sonic"
]
},
"status": {
"type": "string",
"enum": [
"draft",
"shortlisted",
"approved",
"rejected",
"scheduled",
"posted",
"needs_attention"
]
},
"sellStyle": {
"type": "string",
"enum": [
"none",
"soft",
"hard"
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundTiktokUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"soundInstagramUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"angle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"seed": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
{
"type": "array",
"items": {}
},
{
"type": "object",
"additionalProperties": {}
}
]
},
{
"type": "null"
}
]
},
"learningContext": {
"anyOf": [
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"account",
"workspace",
"cohort",
"none"
]
},
"checkpoint": {
"anyOf": [
{
"type": "string",
"enum": [
"24h",
"7d"
]
},
{
"type": "null"
}
]
},
"experimental": {
"type": "boolean"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"effectiveFormatMix": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"effectiveAngleWeights": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"scope",
"checkpoint",
"experimental",
"reasons",
"effectiveFormatMix",
"effectiveAngleWeights"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"turboDeckRank": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"turboAutoDiscardedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renderedMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"renderedNoMusicMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"timelineRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderedRev": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"renderStatus": {
"type": "string",
"enum": [
"idle",
"queued",
"rendering",
"failed"
]
},
"renderError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"slides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"idx": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trackType": {
"type": "string",
"enum": [
"visual",
"text",
"audio"
]
},
"trackIndex": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineStartMs": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"timelineDurationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageBrief": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"overlayBoxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"font": {
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
]
},
"weight": {
"type": "string",
"enum": [
"400",
"600",
"700",
"800"
]
},
"size": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "integer",
"minimum": 12,
"maximum": 48
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"strokeWidth": {
"type": "number",
"minimum": 0,
"maximum": 4
},
"strokeColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"minimum": 0.8,
"maximum": 2
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.5
},
"textCase": {
"type": "string",
"enum": [
"none",
"upper",
"lower"
]
},
"bodyColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bodyCase": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"upper",
"lower"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyFont": {
"anyOf": [
{
"type": "string",
"enum": [
"sora",
"manrope",
"tiktok_sans",
"montserrat",
"poppins",
"inter",
"roboto",
"open_sans",
"dm_sans",
"plus_jakarta_sans",
"lato",
"oswald",
"anton",
"bebas_neue",
"abel",
"playfair_display",
"dancing_script",
"caveat",
"source_code_pro"
],
"default": null
},
{
"type": "null"
}
]
},
"bodyBgColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"default": null
},
{
"type": "null"
}
]
},
"bgMode": {
"type": "string",
"enum": [
"scrim",
"solid",
"highlight",
"none"
]
},
"bgColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.35,
"maximum": 1.1889952153110048
},
"fit": {
"type": "string",
"enum": [
"hook",
"cover",
"quiet"
],
"default": "hook"
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"card": {
"anyOf": [
{
"type": "string",
"enum": [
"x",
"reddit",
"notes",
"linkedin",
"imessage",
"chatgpt",
"notification"
],
"default": null
},
{
"type": "null"
}
]
}
},
"required": [
"font",
"weight",
"size",
"color",
"strokeWidth",
"strokeColor",
"align",
"lineHeight",
"letterSpacing",
"textCase",
"bgMode",
"bgColor",
"x",
"y",
"width"
],
"additionalProperties": false
},
"cardHandle": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"default": null
},
{
"type": "null"
}
]
},
"behindPhotos": {
"type": "boolean",
"default": false
}
},
"required": [
"text",
"style"
],
"additionalProperties": false
}
},
"mediaFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"photoAdjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false
},
"layout": {
"type": "string",
"enum": [
"full",
"stack2",
"side2",
"rows3",
"grid4",
"grid6"
]
},
"layoutCells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"overlayImages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"format": "uuid"
},
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"minimum": 0.08,
"maximum": 1
},
"frame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"zoom": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180,
"default": 0
},
"adjust": {
"type": "object",
"properties": {
"brightness": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"contrast": {
"type": "number",
"minimum": 0.2,
"maximum": 2
},
"saturation": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"grayscale": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"sepia": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"brightness",
"contrast",
"saturation",
"grayscale",
"sepia"
],
"additionalProperties": false,
"default": {
"brightness": 1,
"contrast": 1,
"saturation": 1,
"grayscale": 0,
"sepia": 0
}
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"mediaId",
"x",
"y",
"width",
"frame",
"url",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"layerFrame": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"width": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"height": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
},
"overlayMotion": {
"anyOf": [
{
"type": "object",
"properties": {
"entrance": {
"type": "string",
"enum": [
"pop",
"bounce",
"scale",
"cut"
]
},
"exit": {
"type": "string",
"enum": [
"fade",
"scale",
"cut"
]
}
},
"required": [
"entrance",
"exit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"opacity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"volume": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"muted": {
"type": "boolean"
},
"imageIntent": {
"anyOf": [
{
"type": "string",
"enum": [
"persona",
"lifestyle"
]
},
{
"type": "null"
}
]
},
"trimInMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"trimOutMs": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"keyColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keySimilarity": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"keyBlend": {
"type": "number",
"minimum": -140737488355328,
"maximum": 140737488355327
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mediaKind": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
{
"type": "null"
}
]
},
"mediaAiGenerated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"idx",
"trackType",
"trackIndex",
"timelineStartMs",
"timelineDurationMs",
"label",
"imageBrief",
"mediaId",
"overlayBoxes",
"mediaFrame",
"photoAdjust",
"layout",
"layoutCells",
"overlayImages",
"layerFrame",
"overlayMotion",
"opacity",
"volume",
"muted",
"imageIntent",
"trimInMs",
"trimOutMs",
"keyColor",
"keySimilarity",
"keyBlend",
"createdAt",
"url",
"sourceDurationMs",
"mediaKind",
"mediaAiGenerated"
],
"additionalProperties": false
}
},
"renderedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderedDurationMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"renderStale": {
"type": "boolean"
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"targetAccountId",
"remixedFromId",
"remixSourceUrl",
"remixSkeletonId",
"tweakedFromId",
"savedTemplateId",
"format",
"origin",
"generationSource",
"status",
"sellStyle",
"caption",
"soundTiktokUrl",
"soundInstagramUrl",
"hashtags",
"angle",
"seed",
"learningContext",
"turboDeckRank",
"turboAutoDiscardedAt",
"renderedMediaId",
"renderedNoMusicMediaId",
"timelineRev",
"renderedRev",
"renderStatus",
"renderError",
"createdAt",
"updatedAt",
"slides",
"renderedUrl",
"renderedDurationMs",
"renderStale"
],
"additionalProperties": false
},
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"contentItemId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"posting",
"posted",
"awaiting_user_publish",
"failed",
"canceled"
]
},
"publishJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"runAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"externalUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hashtags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isAigc": {
"type": "boolean"
},
"isPaidPartnership": {
"type": "boolean"
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"metricsSyncedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEligible": {
"type": "boolean"
},
"learningExclusionReason": {
"anyOf": [
{
"type": "string",
"enum": [
"paid_or_boosted",
"repost",
"unverified",
"manual"
]
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"workspaceId",
"contentItemId",
"accountId",
"status",
"publishJobId",
"runAt",
"postedAt",
"externalUrl",
"externalId",
"failureCode",
"failureMessage",
"caption",
"hashtags",
"isAigc",
"isPaidPartnership",
"views",
"likes",
"comments",
"saves",
"metricsSyncedAt",
"learningEligible",
"learningExclusionReason",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"content",
"post",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Jobs and frame review
get_jobRead
Read generation or render progress, result IDs, cancellation availability, and video frames awaiting approval. Use get_content or get_media_url for finished previews. Poll about every 2 seconds while work is active.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
job_id | Yes | uuid |
Input example
{
"job_id": "11111111-1111-4111-8111-111111111111"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"job_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"job_id"
]
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, type, status, progressStage, runAt, retryCount, claimedAt, providerJobId, priority, result, error, createdAt, updatedAt, canCancel, canRetry, frameReview.
{
"id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"progressStage": null,
"result": null,
"error": null,
"canCancel": true,
"canRetry": false,
"frameReview": null,
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111"
},
"pollIntervalMs": 2000
},
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_provider",
"completed",
"failed",
"cancelled",
"awaiting_review"
]
},
"progressStage": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing",
"planning",
"selecting_photos",
"rendering_images",
"creating_frames",
"speaking",
"rendering_video",
"composing_video",
"saving",
"adding_visual_inserts"
]
},
{
"type": "null"
}
]
},
"runAt": {
"type": "string",
"format": "date-time"
},
"retryCount": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"claimedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"providerJobId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"priority": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"result": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"contentItemId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"mediaAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"contentItemId",
"mediaAssetIds"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"contentItemIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"requested": {
"type": "integer",
"minimum": 0
}
},
"required": [
"contentItemIds",
"requested"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"brand_build"
]
},
"sources": {
"type": "object",
"properties": {
"website": {
"type": "string",
"enum": [
"ok",
"not_found",
"private",
"unavailable",
"failed",
"skipped"
]
},
"tiktok": {
"type": "string",
"enum": [
"ok",
"not_found",
"private",
"unavailable",
"failed",
"skipped"
]
},
"instagram": {
"type": "string",
"enum": [
"ok",
"not_found",
"private",
"unavailable",
"failed",
"skipped"
]
}
},
"required": [
"website",
"tiktok",
"instagram"
],
"additionalProperties": false
},
"sitePhotosExpected": {
"type": "boolean"
},
"socialPhotosExpected": {
"type": "boolean"
}
},
"required": [
"kind",
"sources",
"sitePhotosExpected",
"socialPhotosExpected"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"canCancel": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"frameReview": {
"anyOf": [
{
"type": "object",
"properties": {
"frames": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"reshootsLeft": {
"type": "integer",
"minimum": 0
}
},
"required": [
"url",
"reshootsLeft"
],
"additionalProperties": false
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"frames",
"expiresAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"type",
"status",
"progressStage",
"runAt",
"retryCount",
"claimedAt",
"providerJobId",
"priority",
"result",
"error",
"createdAt",
"updatedAt",
"canCancel",
"canRetry",
"frameReview",
"workspaceId",
"brandName"
],
"additionalProperties": true
}list_jobsRead
List active jobs in this workspace, including generation and timeline renders.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
Input example
{}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: feedbackPending, items.
{
"items": [],
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"feedbackPending": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"face_swap",
"multiply",
"tweak",
"improve_photo",
"improve_video",
"photo_shoot",
"video_shoot",
"post",
"video_render",
"discover_refresh",
"research_refresh"
]
},
"count": {
"type": "integer",
"exclusiveMinimum": true,
"minimum": 0
},
"creatorName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"creatorPhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourceContentItemId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"canCancel": {
"type": "boolean"
},
"awaitingReview": {
"type": "boolean"
},
"href": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"count",
"creatorName",
"creatorPhotoMediaId",
"sourceContentItemId",
"canCancel",
"awaitingReview",
"href"
],
"additionalProperties": false
}
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"feedbackPending",
"items",
"workspaceId",
"brandName"
],
"additionalProperties": true
}cancel_jobWrite
Stop a job only when its result says canCancel. Work that has already spent credits cannot be stopped.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
job_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"job_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "cancel_job-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"job_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"job_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "cancelled",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"cancelled"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"workspaceId",
"brandName"
],
"additionalProperties": true
}approve_video_framesWrite
Approve the opening frames shown by get_job and continue the already-reserved video render. Only do this after the user approves the previews.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
job_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"job_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "approve_video_frames-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"job_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"job_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"workspaceId",
"brandName"
],
"additionalProperties": true
}reshoot_video_frameWrite
Reshoot an opening frame with an optional note before video rendering. Subsequent frames are also redrawn. get_job shows the remaining reshoots.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
job_id | Yes | uuid |
note | No / conditional | stringmaxLength: 300 |
index | Yes | integerminimum: 0 |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"job_id": "11111111-1111-4111-8111-111111111111",
"index": 0,
"idempotency_key": "reshoot_video_frame-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"job_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"job_id"
]
},
{
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 300
}
}
},
{
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0
}
},
"required": [
"index"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: jobId, status.
{
"jobId": "44444444-4444-4444-8444-444444444444",
"status": "queued",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand",
"nextAction": {
"tool": "get_job",
"arguments": {
"job_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Full result schema
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"jobId",
"status",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Accounts
get_accountRead
Inspect one social account, its connection and settings.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, platform, handle, displayName, bio, profilePhotoMediaId, uploadPostProfileId, connectionStatus, kind, orderId, country, readyEmailSentAt, baselineFollowers, baselineCapturedAt, learningEnabled, learningResetAt, creditGraceSince, billingCycleId, nextCreditDeductionAt, renewalWarningSentFor, creditReleasedAt, keywords, etaGoLive, etaLastChangedAt, warmingCompletedAt, warmingSessionsCompleted, warmingSessionsRequired, nextSessionAt, detailsLockedAt, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "tiktok",
"handle": "Example",
"uploadPostProfileId": "Example",
"connectionStatus": "pending",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}get_account_activityRead
Read an account's posting activity and queue.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: events, sessionsDone, sessionsTotal, queuedPosts.
{
"events": [],
"sessionsDone": 0,
"sessionsTotal": 0,
"queuedPosts": 0,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"occurredAt": {
"type": "string"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id",
"type",
"occurredAt",
"title",
"body"
],
"additionalProperties": false
}
},
"sessionsDone": {
"type": "number"
},
"sessionsTotal": {
"type": "number"
},
"queuedPosts": {
"type": "number"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"events",
"sessionsDone",
"sessionsTotal",
"queuedPosts",
"workspaceId",
"brandName"
],
"additionalProperties": true
}update_accountWrite
Edit an account's influencer assignment, profile settings, learning, or pause state. Resuming a released account may charge 100 credits for a connected account or 2000 for a managed account.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
influencerId | No / conditional | uuid | null |
handle | No / conditional | string |
displayName | No / conditional | stringminLength: 1maxLength: 30 |
bio | No / conditional | string | null |
profilePhotoMediaId | No / conditional | uuid | null |
country | No / conditional | "us" | "uk" |
paused | No / conditional | boolean |
learningEnabled | No / conditional | boolean |
resetLearning | No / conditional | true |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"account_id": "33333333-3333-4333-8333-333333333333",
"idempotency_key": "update_account-example-1",
"paused": true
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"handle": {
"type": "string"
},
"displayName": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"bio": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"type": "string",
"enum": [
"us",
"uk"
]
},
"paused": {
"type": "boolean"
},
"learningEnabled": {
"type": "boolean"
},
"resetLearning": {
"type": "boolean",
"const": true
}
}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, platform, handle, displayName, bio, profilePhotoMediaId, uploadPostProfileId, connectionStatus, kind, orderId, country, readyEmailSentAt, baselineFollowers, baselineCapturedAt, learningEnabled, learningResetAt, creditGraceSince, billingCycleId, nextCreditDeductionAt, renewalWarningSentFor, creditReleasedAt, keywords, etaGoLive, etaLastChangedAt, warmingCompletedAt, warmingSessionsCompleted, warmingSessionsRequired, nextSessionAt, detailsLockedAt, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "tiktok",
"handle": "Example",
"uploadPostProfileId": "Example",
"connectionStatus": "pending",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}start_account_connectionWrite
Start connecting or reconnecting a social account. Return connectUrl to the user to complete provider sign-in; never ask for their password. Connecting costs 100 credits when completed and renews monthly under the existing account rules.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
influencerId | No / conditional | uuid |
platform | Yes | "tiktok" | "instagram" |
accountId | No / conditional | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"platform": "instagram",
"idempotency_key": "start_account_connection-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"influencerId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"accountId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"platform"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: attemptId, connectUrl, uploadPostProfileId.
{
"attemptId": "11111111-1111-4111-8111-111111111111",
"connectUrl": "https://example.com/provider-sign-in",
"uploadPostProfileId": "returned-profile-id",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"format": "uuid"
},
"connectUrl": {
"type": "string"
},
"uploadPostProfileId": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"attemptId",
"connectUrl",
"uploadPostProfileId",
"workspaceId",
"brandName"
],
"additionalProperties": true
}complete_account_connectionWrite
Check and complete a provider connection after the user has signed in. Use the attemptId as account_id. May charge 100 credits when connected. Pending means the user still needs to finish authorization.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "complete_account_connection-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: status, account.
{
"status": "pending",
"account": null,
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"pending"
]
},
"account": {
"type": "null"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"status",
"account",
"workspaceId",
"brandName"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"connected"
]
},
"account": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"status",
"account",
"workspaceId",
"brandName"
],
"additionalProperties": true
}
]
}manage_account_connectionWrite
Return the provider's link for the user to reconnect or revoke a connected account. The user completes that action in the provider screen.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "manage_account_connection-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: connectUrl.
{
"connectUrl": "https://example.com/provider-manage",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"connectUrl": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"connectUrl",
"workspaceId",
"brandName"
],
"additionalProperties": true
}reconcile_accountWrite
Refresh a connected account's state after the user changes its provider connection.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111",
"idempotency_key": "reconcile_account-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {}
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, platform, handle, displayName, bio, profilePhotoMediaId, uploadPostProfileId, connectionStatus, kind, orderId, country, readyEmailSentAt, baselineFollowers, baselineCapturedAt, learningEnabled, learningResetAt, creditGraceSince, billingCycleId, nextCreditDeductionAt, renewalWarningSentFor, creditReleasedAt, keywords, etaGoLive, etaLastChangedAt, warmingCompletedAt, warmingSessionsCompleted, warmingSessionsRequired, nextSessionAt, detailsLockedAt, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "tiktok",
"handle": "Example",
"uploadPostProfileId": "Example",
"connectionStatus": "pending",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}delete_accountWrite
Delete or disconnect an account under the app's existing rules. This can stop its scheduled posting. Only call when the user explicitly requests it and confirm=true.
Parameters
| Name | Required | Type and constraints |
|---|---|---|
workspace_id | No / conditional | uuid |
account_id | Yes | uuid |
confirm | Yes | true |
idempotency_key | Yes | stringminLength: 1maxLength: 200 |
Input example
{
"account_id": "11111111-1111-4111-8111-111111111111",
"confirm": true,
"idempotency_key": "delete_account-example-1"
}Full input schema
{
"allOf": [
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"account_id"
]
},
{
"type": "object",
"properties": {
"confirm": {
"type": "boolean",
"const": true
}
},
"required": [
"confirm"
]
},
{
"type": "object",
"properties": {
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"idempotency_key"
]
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}Result
Every result identifies workspaceId and brandName. Other result fields: id, workspaceId, influencerId, platform, handle, displayName, bio, profilePhotoMediaId, uploadPostProfileId, connectionStatus, kind, orderId, country, readyEmailSentAt, baselineFollowers, baselineCapturedAt, learningEnabled, learningResetAt, creditGraceSince, billingCycleId, nextCreditDeductionAt, renewalWarningSentFor, creditReleasedAt, keywords, etaGoLive, etaLastChangedAt, warmingCompletedAt, warmingSessionsCompleted, warmingSessionsRequired, nextSessionAt, detailsLockedAt, createdAt, updatedAt, profilePhotoUrl.
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "tiktok",
"handle": "Example",
"uploadPostProfileId": "Example",
"connectionStatus": "pending",
"brandName": "Example brand"
}Full result schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"influencerId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"tiktok",
"instagram"
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bio": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profilePhotoMediaId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"uploadPostProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connectionStatus": {
"type": "string",
"enum": [
"pending",
"live",
"warming",
"provisioning",
"waitlisted",
"paused",
"disconnected"
]
},
"kind": {
"type": "string",
"enum": [
"self_connected",
"warmed"
]
},
"orderId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"enum": [
"us",
"uk"
]
},
{
"type": "null"
}
]
},
"readyEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"baselineFollowers": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"baselineCapturedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"learningEnabled": {
"type": "boolean"
},
"learningResetAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditGraceSince": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"billingCycleId": {
"type": "string",
"format": "uuid"
},
"nextCreditDeductionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"renewalWarningSentFor": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"creditReleasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"etaGoLive": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"etaLastChangedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingCompletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"warmingSessionsCompleted": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"warmingSessionsRequired": {
"anyOf": [
{
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"nextSessionAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"detailsLockedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"profilePhotoUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"brandName": {
"type": "string"
},
"creditBalance": {
"type": "number",
"description": "Added after a call reserves credits; not guaranteed on free calls."
},
"nextAction": {
"type": "object",
"description": "Present on uploads, job results, and calls returning a jobId; see workflows."
}
},
"required": [
"id",
"workspaceId",
"influencerId",
"platform",
"handle",
"displayName",
"bio",
"profilePhotoMediaId",
"uploadPostProfileId",
"connectionStatus",
"kind",
"orderId",
"country",
"readyEmailSentAt",
"baselineFollowers",
"baselineCapturedAt",
"learningEnabled",
"learningResetAt",
"creditGraceSince",
"billingCycleId",
"nextCreditDeductionAt",
"renewalWarningSentFor",
"creditReleasedAt",
"keywords",
"etaGoLive",
"etaLastChangedAt",
"warmingCompletedAt",
"warmingSessionsCompleted",
"warmingSessionsRequired",
"nextSessionAt",
"detailsLockedAt",
"createdAt",
"updatedAt",
"workspaceId",
"brandName"
],
"additionalProperties": true
}Internal-only tools
Amplify team accounts can additionally discover list_feedback_tickets, get_feedback_ticket, update_feedback_ticket, add_feedback_note, and bump_feedback_ticket. These are not available to ordinary customer accounts and are outside this customer reference.