Share a render

curl --request POST \
  --url https://api.sigmora.org/v1/projects/{projectId}/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoJobId": "job_4k1b7d",
  "operation": "create",
  "mutationKey": "share-week5-launch",
  "expiry": "30d"
}
'

import requests

url = "https://api.sigmora.org/v1/projects/{projectId}/share"

payload = {
    "videoJobId": "job_4k1b7d",
    "operation": "create",
    "mutationKey": "share-week5-launch",
    "expiry": "30d"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    videoJobId: 'job_4k1b7d',
    operation: 'create',
    mutationKey: 'share-week5-launch',
    expiry: '30d'
  })
};

fetch('https://api.sigmora.org/v1/projects/{projectId}/share', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "access": "<string>",
  "shareUrl": "<string>",
  "embedUrl": "<string>",
  "expiresAt": "<string>",
  "allowComments": true,
  "message": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

POST

projects

{projectId}

Share a render

curl --request POST \
  --url https://api.sigmora.org/v1/projects/{projectId}/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoJobId": "job_4k1b7d",
  "operation": "create",
  "mutationKey": "share-week5-launch",
  "expiry": "30d"
}
'

import requests

url = "https://api.sigmora.org/v1/projects/{projectId}/share"

payload = {
    "videoJobId": "job_4k1b7d",
    "operation": "create",
    "mutationKey": "share-week5-launch",
    "expiry": "30d"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    videoJobId: 'job_4k1b7d',
    operation: 'create',
    mutationKey: 'share-week5-launch',
    expiry: '30d'
  })
};

fetch('https://api.sigmora.org/v1/projects/{projectId}/share', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "access": "<string>",
  "shareUrl": "<string>",
  "embedUrl": "<string>",
  "expiresAt": "<string>",
  "allowComments": true,
  "message": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Path Parameters

projectId

string

required

The project id.

Required string length: 1 - 200

Body

application/json

videoJobId

string

required

A finished (ready or published) render of this project: render.id from the transcript read.

Required string length: 1 - 200

operation

enum<string>

required

reveal reads the current link; create makes one; replace swaps it for a new URL; revoke turns it off; set-comments switches viewer comments.

Available options:

create,

reveal,

replace,

revoke,

set-comments

mutationKey

string

Required for every operation except reveal: 8-128 of A-Z a-z 0-9 : _ -. Reuse it to retry safely.

Maximum string length: 128

expiry

enum<string>

How long a created or replaced link works; omitted means it never expires.

Available options:

7d,

30d,

never

allowEmbedding

boolean

Whether the link may be embedded in other sites.

allowComments

boolean

Whether viewers of the link may leave review notes.

Response

Success.

success

boolean

required

access

string

required

public, none or expired, or another access state.

embedUrl

string | null

required

expiresAt

string | null

required

allowComments

boolean

required

message

string | null

required

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Share a render

Authorizations

Path Parameters

Body

Response