Delete Generation | sync. labs

{
  "id": "6533643b-aceb-4c40-967e-d9ba9baac39e",
  "organizationId": "6d2f4b8a-1e3c-4a5b-9c7d-8e9f0a1b2c3d",
  "userId": "1c3a7c1e-9f2b-4e7a-9a53-1f0c3b2d4e5f",
  "apiKeyId": null,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:45:00Z",
  "startedAt": "2024-01-15T09:30:05Z",
  "finishedAt": "2024-01-15T09:31:10Z",
  "status": "COMPLETED",
  "model": {
    "id": "lipsync-2",
    "name": "lipsync-2",
    "description": null,
    "type": "lipsync",
    "version": "2.0.0",
    "features": [],
    "deprecatedAt": null
  },
  "modelName": "lipsync-2",
  "inputs": [
    {
      "type": "video",
      "url": "https://example.com/video.mp4"
    },
    {
      "type": "audio",
      "url": "https://example.com/audio.wav"
    }
  ],
  "webhookUrl": null,
  "thumbnailUrl": null,
  "frameCount": 300,
  "options": {},
  "outputMediaUrl": "https://example.com/output.mp4",
  "segmentOutputMediaUrl": null,
  "segmentOutputBucketPath": null,
  "outputMediaLength": 10,
  "potentialError": null,
  "isPublic": false,
  "deletedAt": "2024-01-15T09:45:00Z",
  "projectId": null
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

A unique identifier for the generation.

Response

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.

Allowed values:

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 nullOptional

playbackMediaUrlstring or nullOptional

Browser playback URL, using a preview when available. Use outputMediaUrl or the download endpoint for the original output. Returned on project responses.

creatorNamestring or nullOptional

outputFileNamestring or nullOptional

outputExtensionstring or nullOptional

generationEstimateobject or nullOptional

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

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error