SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Read one video: its scenes, voice-over status and the link to watch and download it

Poll it after POST /stories until soundtrack.status is ready (usually under a minute). links.open is the page where the person watches it with sound and downloads the MP4; video.download_url is the MP4 itself once it has been made.

GEThttps://app.softsolz.uk/api/v1/services/creative-studio/designs/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Response

Response Body

idstringDesign id.
titlestringTitle shown in the library.
formatstringstory (9:16), landscape (16:9), square (1:1) or a picture format.
widthintegerWidth in pixels.
heightintegerHeight in pixels.
versionintegerCurrent version. Every change makes a new one.
saved_atstring | nullWhen it joined the library.
created_atstringWhen it was made.
updated_atstringSend it back as expected_updated_at to make sure nobody changed the video since you read it.
is_storybooleanTrue for a story video made from a template.
storyobject | nullThe scenes of a story video. null for a picture or a custom design.
soundtrackobject | nullVoice-over and music. null when the design has none.
videoobjectThe MP4 file of the current version.
linksobjectPages in SoftSolz for this design.
notesarray of stringsOnly on create and change: anything that was adjusted, such as text that was shortened.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/creative-studio/designs/{id} \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"id": "your-id",
"title": "your-title",
"format": "your-format",
"width": 1,
"height": 1,
"version": 1,
"saved_at": "2026-01-01T09:00:00.000Z",
"created_at": "2026-01-01T09:00:00.000Z",
"updated_at": "2026-01-01T09:00:00.000Z",
"is_story": true,
"story": {
"template": "your-template",
"format": "story",
"category": "your-category",
"voice": "your-voice",
"music": "your-music",
"target_seconds": 1,
"product_asset_id": "your-product-asset-id",
"scenes": [
{
"kind": "hook",
"fields": {},
"narration": "your-narration",
"image": "product"
}
]
},
"soundtrack": {
"status": "queued",
"voice": "your-voice",
"music": "your-music",
"total_ms": 1,
"error_code": "your-error-code",
"lines": 1,
"updated_at": "2026-01-01T09:00:00.000Z"
},
"video": {
"duration_ms": 1,
"mp4_ready": true,
"download_url": "https://example.com",
"download_expires_at": "2026-01-01T09:00:00.000Z"
},
"links": {
"open": "your-open"
},
"notes": [
"your-notes"
]
}
}