Saltar a la navegación

delete generation

Delete a generation. Generations are organization-scoped, so any member — or an API key for the organization — can delete one. Only generations in a terminal state can be deleted; deleting one that is still processing returns 409 (errorCode generation_not_deletable_while_processing). Returns the deleted generation in its stored shape (modelName, inputs, outputMediaUrl, deletedAt), not the Get Generation shape.

Autenticación

x-api-keystring
Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido
A unique identifier for the generation.

Respuesta

The deleted generation, in the stored-generation shape.

idstring
A unique identifier for the generation.
organizationIdstring
userIdstring or null
apiKeyIdstring or null
createdAtdatetime
updatedAtdatetime
startedAtdatetime or null
finishedAtdatetime or null
statusenum
The status of the generation. COMPLETED, FAILED and REJECTED are terminal. For FAILED or REJECTED, inspect errorCode and errorMessage before retrying.
Valores permitidos:
modelobject
modelNamestring
inputslist of objects
webhookUrlstring or null
thumbnailUrlstring or null
frameCountdouble or null
optionsmap from strings to any

Persisted generation options, including server-owned fields. This is not a create-request options contract.

outputMediaUrlstring or null
segmentOutputMediaUrlstring or null
segmentOutputBucketPathstring or null
outputMediaLengthdouble or null
potentialErrorobject or null
isPublicboolean or null
deletedAtdatetime or null
projectIdstring or null
A unique identifier for a project.
segmentslist of objects or nullOpcional
playbackMediaUrlstring or nullOpcional
Browser playback URL, using a preview when available. Use outputMediaUrl or the download endpoint for the original output. Returned on project responses.
creatorNamestring or nullOpcional
outputFileNamestring or nullOpcional
outputExtensionstring or nullOpcional
generationEstimateobject or nullOpcional

A completion-time estimate produced when a generation is accepted.

Errores

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error