Cancels influencer media generation task

PATCH 
/api/influencer/imgen/:task_id/cancel

Cancels influencer media generation task

Request

Path Parameters

task_id uuidrequired

Id of a task

Responses

200

Successful operation

application/json

Schema

Schema

id uuidrequired

The unique identifier of the influencer image generation task.

influencer_id uuidrequired

The unique identifier of the influencer.

type InfluencerMediaGenerationTaskTyperequired

Possible values: [image, video]

Type of generation task

status InfluencerMediaGenerationTaskStatusrequired

Possible values: [init, in_progress, succeed, failed]

Influencer media generation task status

images object[]required
An array of images associated with the influencer generation task.
Array [
url urlrequired
The URL of the media.
]
videos object[]required
An array of videos associated with the influencer generation task.
Array [
url urlrequired
The URL of the media.
]
archive urlrequired

The URL of the archive with generated images.

errors InfluencerImageGenerationTaskError[]required

Possible values: [explicit, no_activity, no_place, no_wearing, no_time, no_atmosphere, no_emotion, timeout]

An array of errors associated with the influencer image generation task.

images_count integerrequired

Possible values: >= 1

The number of images to generate.

prompt stringrequired

The prompt for the image generation.

background_removed booleanrequired

A sign if background is removed.

video_scene_url stringrequired

A URL to video scene of a video generation

video_scene_id uuidrequired

An id of a video scene template

created_at_utc date-timerequired

The creation time of the influencer image generation task.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "influencer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "image",
  "status": "init",
  "images": [
    {
      "url": "string"
    }
  ],
  "videos": [
    {
      "url": "string"
    }
  ],
  "archive": "string",
  "errors": [
    "explicit"
  ],
  "images_count": 0,
  "prompt": "string",
  "background_removed": true,
  "video_scene_url": "string",
  "video_scene_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at_utc": "2024-09-13T10:30:55.769Z"
}

default

Unexpected error

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...