RaylightAPI

Remakes

Generate one backdrop

Generates one backdrop on Raylight's image model: a still repaints the reference frame without what stands in front, a plate grows a still outward. Answers a short-lived link to the image. Bounded per remake (code backdrop_cap). Upload the image into the project like any other media.

POST/v1/remakes/{id}/backdrops

API key with the remake scope.

Parameters

FieldInTypeDescription
idrequiredpathuuidThe remake id.

Request body

application/json

FieldTypeDescription
kindrequiredenumOne of: still, plate
promptrequiredstring
widthrequiredinteger
heightrequiredinteger
seedinteger
imagerequiredstring
originalobject
original.xrequiredinteger
original.yrequiredinteger
original.widthrequiredinteger
original.heightrequiredinteger

Responses

200The generated image.
400Invalid request.
401Missing, invalid or revoked key.
403The key lacks the scope, or the key's owner has view-only access to the workspace (code forbidden).
404Not found.
409The remake is not at a stage that takes this call, or it already ended (code stage).
429The remake used every backdrop it gets (code backdrop_cap), or the rate limit (Retry-After).
503The image model is unavailable; retry shortly (code busy). Carries Retry-After.

200 response body

FieldTypeDescription
urlrequiredurl
assetIdstring

Example

curl
curl -X POST https://api.raylight.app/v1/remakes/$ID/backdrops \  -H "Authorization: Bearer $RAYLIGHT_API_KEY" \  -H "Content-Type: application/json" \  -d '{  "kind": "still",  "prompt": "<prompt>",  "width": 16,  "height": 16,  "image": "<image>"}'