Sorceress · IMAGE

Corridor Key API

Corridor Key green/blue-screen removal for any still image. Pass imageUrl, poll until succeeded, use transparentUrl. Same cloud GPU as /corridor-chroma. keyColor "auto" detects the plate. For AutoSprite videos use autosprite_key; for Parallax layers you may use this or parallax_key. Async — poll GET /api/v1/jobs/:id.

Available through Sorceress API

Use with an AI agentManage API keys
Corridor Key model artwork

Using Corridor Key in your workflow

Sorceress brings this custom workflow into a shared API catalog. Select this model explicitly, check its supported inputs, and keep your API key on your server. Model capabilities differ; the schema and options on this page describe this entry rather than every model from the same brand.

  • Remove a green or blue background from a still image while preserving transparency.
  • Prepare keyed sprites and layers for compositing; choose a working size up to 1536 pixels.

Pricing and availability

Same as UI Corridor Chroma stills: ~1 credit per image at ≤512px (2× above 512). VIP free. Charged only on success. Local GPU via sorcgcs-server is free.. Successful work is billed in Sorceress credits. Defaults and optional inputs can affect the total.

Inputs and supported options

imageUrlstring · required

https URL of a chroma-screen still (green or blue). e.g. images[0].url from image_generate, or a publicUrl from file_upload.

keyColorstring · optional

"auto" (default — detect green or blue plate from image borders) or a hex like "#00b140" / "#0040FF".

screenColorstring · optional

Corridor Key checkpoint: "auto" (default, from the detected/hex plate), "green", or "blue". Use when auto-detect is unsure.

tolerancenumber · optional

Chroma distance tolerance for the alpha hint (default 80).

maxSidenumber · optional

Max working side before Corridor Key (512 = fast default, 1024 or 1536 = higher quality). Source is fit inside this box without upscaling.

labelstring · optional

Optional short label stored on the job / gallery row (e.g. filename).

API request template

Replace placeholders and choose valid values from the input contract. 

POST /api/v1/tools/corridor_key
Authorization: Bearer $SORCERESS_API_KEY
Content-Type: application/json

{
  "imageUrl": "<imageUrl>"
}
Read the endpoint reference →

Completion, results and billing

Save the job identifier returned by asynchronous requests and poll the jobs endpoint until the job succeeds or fails. Do not resubmit a generation just because it is still processing. Chat returns a completed reply and usage details. A multi-step workflow can include separately billed successful steps even if a later step fails. Keep returned asset links with your project, and consult each action for its output format.

Coding agents can discover the current catalog and input requirements from the Sorceress agent instructions. Use a Sorceress key; provider credentials stay on the server.