SwapStudio API
Create character swaps and Quick Swaps from your own app, and get updates pushed to you when a swap is ready. The API follows the same rules as the website.
Your API keys
Checking whether you are signed in...
How it works
- Same rules as the website. Accept the SwapStudio terms (18+, US) on the swap page once. Every job needs a signed consent for everyone in the files. A person reviews each new swap before it renders. Outputs are labeled AI-generated in the file.
- Credits. API swaps are paid from your credit balance. Buy credits on the website; a job with too few credits is refused with how many it needs.
- Keys. Base URL
https://app.swapstudio.summitnet.io/v1, headerAuthorization: Bearer ssk_live_.... Keep the key on your server. Up to 5 keys per account; revoking one stops it within 30 seconds. - Spec. OpenAPI 3.1. Errors are
{"error": "message"}with the HTTP status. 120 requests a minute per key, plus the website's upload and job limits.
1. Upload the clip and the photo
curl https://app.swapstudio.summitnet.io/v1/uploads \
-H "Authorization: Bearer $SWAP_KEY" -F "file=@dance.mp4"
curl https://app.swapstudio.summitnet.io/v1/uploads \
-H "Authorization: Bearer $SWAP_KEY" -F "file=@me-full-body.jpg"
# 200 { "upload_id": "...", "kind": "video", "seconds": 9, ... } / { "upload_id": "...", "kind": "image", ... }
Each upload is checked before it is accepted, the same as on the website.
2. Sign the consent
curl -X POST https://app.swapstudio.summitnet.io/v1/consents \
-H "Authorization: Bearer $SWAP_KEY" -H "Content-Type: application/json" \
-d '{ "subjects": [ { "upload_id": "<clip id>", "relationship": "self" },
{ "upload_id": "<photo id>", "relationship": "self" } ],
"attestations": { "have_consent": true, "all_adults": true, "own_clip": true, "biometric": true },
"signed_name": "Jane Doe" }'
# 200 { "consent_id": "..." }
Relationships: self, family, friend, colleague, deceased_immediate_family, minor_child, character (an illustrated character image). Attestations are the swap page's checkboxes: have_consent; all_adults, or guardian_consent when a minor_child is in a file (parent or legal guardian only); own_clip for your clip; biometric (face-data consent) for a swap; own_image for a character image; immediate_family for a late family member. The signed name is your typed e-signature, first and last name.
3. Create the swap
curl -X POST https://app.swapstudio.summitnet.io/v1/jobs \
-H "Authorization: Bearer $SWAP_KEY" -H "Content-Type: application/json" \
-d '{ "product": "<from GET /v1/products>", "inputs": { ... },
"consent_id": "<consent id>", "idempotency_key": "your-order-1042" }'
# 201 { "id": "...", "status": "input_review", ..., "balance": 380 }
Send the same idempotency_key when you retry and you get the same job back, not a second charge. Product names, inputs and prices in credits come from GET /v1/products.
4. Get the result
GET /v1/jobs/{id} status, outputs when done
GET /v1/jobs/{id}/outputs/0 the file (video/mp4 or an image); ?download=1 names it
PATCH /v1/jobs/{id} {"action":"approve_preview"} when a job stops at a preview for your OK
GET /v1/jobs your jobs, newest first
GET /v1/me your account, balance and recent jobs
Statuses: input_review (a person checks it), queued, running, rendering, review, preview_ready, story_ready, done, failed, refunded, cancelled. A failed or refused job is refunded to your balance.
5. Updates pushed to you (webhooks)
curl -X POST https://app.swapstudio.summitnet.io/v1/webhooks \
-H "Authorization: Bearer $SWAP_KEY" -H "Content-Type: application/json" \
-d '{ "url": "https://yourapp.example.com/hooks/swapstudio" }'
# 201 { "id": "...", "secret": "whsec_..." } (the secret is shown once)
curl -X POST https://app.swapstudio.summitnet.io/v1/webhooks/{id}/ping -H "Authorization: Bearer $SWAP_KEY"
We POST { id, type, created_at, previous_status, job } whenever one of your jobs changes status. type is job.ready (done, or a preview or story waiting for your OK), job.failed (failed, refunded or cancelled) or job.status_changed (anything else).
Check X-SwapStudio-Signature: t=<unix seconds>,v1=<hex> before trusting the body: v1 must equal HMAC-SHA256(secret, t + "." + raw body) and t must be within 5 minutes. Deliveries are at least once and in order; de-duplicate on X-SwapStudio-Delivery. Answer 2xx within 10 seconds. Failures retry with backoff up to an hour; 50 in a row switch the webhook off. HTTPS to a public host only, 5 per account.
Questions or a key that leaked: support@summitnet.io. Summit Studios is a Summit Network Solutions LLC company.