{"openapi":"3.1.0","info":{"title":"SwapStudio API","version":"1.0.0","description":"Create character swaps and Quick Swaps from your own systems and get updates pushed to you. The API uses the same rules as the website: your account accepts the SwapStudio terms on the website first, every job needs a signed consent, a person reviews each new swap before it renders, swaps are paid from your credit balance (buy credits on the website), and every output is labeled AI-generated in the file.","contact":{"name":"Summit Networks","email":"support@summitnet.io"}},"servers":[{"url":"https://app.swapstudio.summitnet.io/v1"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"ssk_live_... from /developers"}}},"paths":{"/me":{"get":{"summary":"Your account, credit balance and recent jobs","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/products":{"get":{"summary":"Products, prices in credits, cents per credit","responses":{"200":{"description":"OK"}}}},"/uploads":{"post":{"summary":"Upload one file (multipart/form-data, field \"file\"): a clip (video) or a photo (image)","responses":{"200":{"description":"{upload_id, kind, bytes, seconds?, width?, height?}"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/uploads/{id}":{"patch":{"summary":"Delete an upload early: {\"action\":\"delete\"}","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/consents":{"post":{"summary":"Sign the consent for a job: subjects [{upload_id, relationship}], attestations {have_consent, all_adults | guardian_consent, own_clip, biometric, own_image?, immediate_family?}, signed_name (first and last)","responses":{"200":{"description":"{consent_id}"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/jobs":{"post":{"summary":"Create a swap job (product, inputs, consent_id, idempotency_key). A person reviews it, then it renders.","responses":{"200":{"description":"Same idempotency_key: the existing job"},"201":{"description":"The job and your balance"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}},"get":{"summary":"Your jobs, newest first","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/jobs/{id}":{"get":{"summary":"One job: status, outputs when done","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}},"patch":{"summary":"Decide at a preview or story step: {\"action\":\"approve_preview\"} etc.","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/jobs/{id}/outputs/{n}":{"get":{"summary":"Download output n (video/mp4 or image); add ?download=1 for a file name","responses":{"200":{"description":"The file"},"206":{"description":"Range"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/webhooks":{"get":{"summary":"Your webhooks","responses":{"200":{"description":"OK"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}},"post":{"summary":"Register an https URL for job updates; the signing secret is returned once","responses":{"201":{"description":"{id, url, secret}"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/webhooks/{id}":{"delete":{"summary":"Delete a webhook","responses":{"204":{"description":"Deleted"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}},"/webhooks/{id}/ping":{"post":{"summary":"Send a signed webhook.ping now","responses":{"200":{"description":"{delivered, status|error}"},"400":{"description":"Error: {\"error\": \"message\"}"},"401":{"description":"Error: {\"error\": \"message\"}"},"402":{"description":"Error: {\"error\": \"message\"}"},"403":{"description":"Error: {\"error\": \"message\"}"},"404":{"description":"Error: {\"error\": \"message\"}"},"409":{"description":"Error: {\"error\": \"message\"}"},"429":{"description":"Error: {\"error\": \"message\"}"}}}}},"webhooks":{"jobUpdate":{"post":{"summary":"job.status_changed, job.ready or job.failed","description":"Body {id, type, created_at, previous_status, job}. Verify X-SwapStudio-Signature: t=<unix>,v1=<hex HMAC-SHA256(secret, t + \".\" + raw body)>, reject if t is over 5 minutes old, de-duplicate on X-SwapStudio-Delivery, answer 2xx within 10 s.","responses":{"200":{"description":"Received"}}}}}}