Apply a proposed edit
curl --request POST \
--url https://api.sigmora.org/v1/sigma/proposals/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"proposal": {
"tool": "edit_composition",
"projectId": "prj_9x2a4c",
"input": {
"projectId": "prj_9x2a4c",
"aspect": "9:16"
},
"constraint": {
"compositionId": "comp_main",
"transcriptRanges": [],
"visualRanges": []
},
"request": "make it vertical",
"summary": "Would change Main to a 9:16 canvas.",
"token": "LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE"
},
"threadId": "thread_3a7f19c4"
}
'import requests
url = "https://api.sigmora.org/v1/sigma/proposals/apply"
payload = {
"proposal": {
"tool": "edit_composition",
"projectId": "prj_9x2a4c",
"input": {
"projectId": "prj_9x2a4c",
"aspect": "9:16"
},
"constraint": {
"compositionId": "comp_main",
"transcriptRanges": [],
"visualRanges": []
},
"request": "make it vertical",
"summary": "Would change Main to a 9:16 canvas.",
"token": "LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE"
},
"threadId": "thread_3a7f19c4"
}
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({
proposal: {
tool: 'edit_composition',
projectId: 'prj_9x2a4c',
input: {projectId: 'prj_9x2a4c', aspect: '9:16'},
constraint: {compositionId: 'comp_main', transcriptRanges: [], visualRanges: []},
request: 'make it vertical',
summary: 'Would change Main to a 9:16 canvas.',
token: 'LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE'
},
threadId: 'thread_3a7f19c4'
})
};
fetch('https://api.sigmora.org/v1/sigma/proposals/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"summary": "<string>",
"edits": [
{
"turnId": "<string>",
"summary": "<string>",
"projectId": "<string>",
"compositionId": "<string>",
"revisionId": "<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"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Apply a proposed edit
Apply one edit Sigma proposed in review mode. Runs exactly the signed change that was shown and lands it as a revision. Free.
POST
/
v1
/
sigma
/
proposals
/
apply
Apply a proposed edit
curl --request POST \
--url https://api.sigmora.org/v1/sigma/proposals/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"proposal": {
"tool": "edit_composition",
"projectId": "prj_9x2a4c",
"input": {
"projectId": "prj_9x2a4c",
"aspect": "9:16"
},
"constraint": {
"compositionId": "comp_main",
"transcriptRanges": [],
"visualRanges": []
},
"request": "make it vertical",
"summary": "Would change Main to a 9:16 canvas.",
"token": "LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE"
},
"threadId": "thread_3a7f19c4"
}
'import requests
url = "https://api.sigmora.org/v1/sigma/proposals/apply"
payload = {
"proposal": {
"tool": "edit_composition",
"projectId": "prj_9x2a4c",
"input": {
"projectId": "prj_9x2a4c",
"aspect": "9:16"
},
"constraint": {
"compositionId": "comp_main",
"transcriptRanges": [],
"visualRanges": []
},
"request": "make it vertical",
"summary": "Would change Main to a 9:16 canvas.",
"token": "LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE"
},
"threadId": "thread_3a7f19c4"
}
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({
proposal: {
tool: 'edit_composition',
projectId: 'prj_9x2a4c',
input: {projectId: 'prj_9x2a4c', aspect: '9:16'},
constraint: {compositionId: 'comp_main', transcriptRanges: [], visualRanges: []},
request: 'make it vertical',
summary: 'Would change Main to a 9:16 canvas.',
token: 'LXEWQrcmsEQBYnyp-6wy9chTD7GQPMTbAiWHF5IaSIE'
},
threadId: 'thread_3a7f19c4'
})
};
fetch('https://api.sigmora.org/v1/sigma/proposals/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"summary": "<string>",
"edits": [
{
"turnId": "<string>",
"summary": "<string>",
"projectId": "<string>",
"compositionId": "<string>",
"revisionId": "<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"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
A workspace API key.
Body
application/json
proposals[].proposal from POST /v1/sigma/turns, unchanged; it is signed.
Show child attributes
Show child attributes
The threadId of the turn that made the proposal, so the applied edit is recorded in that conversation. Omit or send null to apply it outside a thread.
Required string length:
1 - 200