JsonCutDocs
V2 APIEndpointsGeneration

Cancel a running generation

Stops a queued or running generation and releases its reserved credits. Required API key scopes: `operations:cancel`.

DELETE
/api/v2/projects/{id}/generations/{operationId}

Authorization

apiKeyAuth

Path Parameters

id*string

Resource identifier

operationId*string

Resource identifier

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/projects/string/generations/string"
Empty

Get a generation GET

Status, progress and, once completed, the result media. wait (seconds, up to 25) holds the answer until the generation ends or the time is up. Required API key scopes: `projects:read`.

Queue a render from the current or pinned project version POST

Queue a render from the current or pinned project version. Asynchronous project, template and inline render submission, status, cancellation and artifact access. Required API key scopes: `projects:read`, `renders:create`.