Tasks Endpoints¶
Generation and processing task management.
Overview¶
| Method | Endpoint | Description |
|---|---|---|
| POST | /tasks/ |
Create task |
| GET | /tasks/{task_id} |
Get task status |
| POST | /tasks/{task_id}/cancel |
Cancel task |
| POST | /tasks/{task_id}/cleanup |
Cleanup task resources |
| POST | /tasks/generation |
Create generation task |
| GET | /tasks/generation/{task_id} |
Get generation task |
| POST | /tasks/generation/{task_id}/cancel |
Cancel generation |
Task Lifecycle¶
stateDiagram-v2
[*] --> Pending: Create
Pending --> Running: Worker picks up
Running --> Completed: Success
Running --> Failed: Error
Running --> Cancelled: User cancels
Completed --> [*]
Failed --> [*]
Cancelled --> [*]API Reference¶
Custom API - Tasks 1.0.0¶
This is a very custom OpenAPI schema
Tasks¶
POST /api/v1/tasks/¶
Create Task
Description
Create and start a new task.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/CreateGenerationTask"
},
{
"$ref": "#/components/schemas/CreateEditingTask"
},
{
"$ref": "#/components/schemas/CreateRefineTask"
},
{
"$ref": "#/components/schemas/CreateExperimentalFalTask"
},
{
"$ref": "#/components/schemas/CreateVideoGenerationTask"
},
{
"$ref": "#/components/schemas/CreateLLMInteractionTask"
},
{
"$ref": "#/components/schemas/CreateBackgroundRemovalTask"
},
{
"$ref": "#/components/schemas/CreateDetailEnhancerTask"
},
{
"$ref": "#/components/schemas/CreateBackgroundFixTask"
},
{
"$ref": "#/components/schemas/CreateImageAdjusterTask"
},
{
"$ref": "#/components/schemas/CreateFaceEnhancerTask"
},
{
"$ref": "#/components/schemas/CreateSegmenterTask"
},
{
"$ref": "#/components/schemas/CreateTransformationsSolverTask"
},
{
"$ref": "#/components/schemas/CreateImageTransformerTask"
},
{
"$ref": "#/components/schemas/CreateBackgroundFixerTask"
},
{
"$ref": "#/components/schemas/CreateCheckerTask"
}
],
"title": "Task Data"
}
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
],
"title": "Response Create Task"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/tasks/¶
List Tasks
Description
List tasks with optional filtering and pagination.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
limit |
query | integer | 100 | No | Maximum number of tasks to return |
origin_instance |
query | No | Filter by origin instance | ||
origin_tenant_id |
query | No | Filter by origin tenant ID | ||
origin_zone |
query | No | Filter by origin zone | ||
skip |
query | integer | 0 | No | Number of tasks to skip |
status |
query | No | Filter by task status | ||
task_type |
query | No | Filter by task type |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
]
},
"title": "Response List Tasks"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/tasks/generation¶
List Generation Tasks
Description
List generation tasks with optional filtering and pagination.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
limit |
query | integer | 100 | No | Maximum number of tasks to return |
origin_instance |
query | No | Filter by origin instance | ||
origin_tenant_id |
query | No | Filter by origin tenant ID | ||
origin_zone |
query | No | Filter by origin zone | ||
skip |
query | integer | 0 | No | Number of tasks to skip |
status |
query | No | Filter by task status | ||
workflow_id |
query | No | Filter by workflow ID |
Responses
[
{
"task_type": "string",
"priority": 0,
"config": null,
"origin_instance": "string",
"origin_zone": null,
"origin_tenant_id": null,
"origin_reference": null,
"id": "a80d6827-1953-4635-807a-47da085c0644",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"started_at": null,
"completed_at": null,
"executor_type": null,
"executor_instance": null,
"celery_task_id": null,
"service_task_id": null,
"provider_type": null,
"active_provider_capabilities": null,
"fallback_provider_type": null,
"fallback_provider_config": null,
"fallback_provider_capabilities": null,
"errors": null,
"error_category": null,
"retry_count": 0,
"progress": 10.12,
"provider_config": null,
"subject_model_path": null,
"product_model_path": null,
"style_model_path": null,
"product2_model_path": null,
"subject_lora_weight": null,
"product_lora_weight": null,
"style_lora_weight": null,
"product2_lora_weight": null,
"workflow_id": null,
"prompt": null,
"width": null,
"height": null,
"seed": null,
"result_image_path": null,
"reference_image_path": null,
"reference_image_strength": null,
"fal_app_id": null,
"fal_request_id": null
}
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/tasks/{task_id}¶
Get Task
Description
Get a specific task by ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
],
"title": "Response Get Task"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/tasks/{task_id}¶
Update Task
Description
Update a specific task.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Request body
Schema of the request body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/EditingTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/RefineTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublicUpdate"
},
{
"$ref": "#/components/schemas/CheckerTaskPublicUpdate"
}
],
"title": "Update Data"
}
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
],
"title": "Response Update Task"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/tasks/{task_id}¶
Delete Task
Description
Delete a task and permanently remove its associated files.
This endpoint: 1. Permanently deletes all associated image files 2. Removes the task record from the database
For image-based tasks (EDITING, GENERATION, REFINE), this will permanently delete all files in: - editings/{task_id}/ for EDITING tasks - generations/{task_id}/ for GENERATION tasks - refines/{task_id}/ for REFINE tasks
Unlike /cleanup, this endpoint completely removes the task from the database (no audit trail).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
],
"title": "Response Delete Task"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/tasks/{task_id}/cleanup¶
Cleanup Task
Description
Clean up a task by marking it as deleted and permanently removing its files.
This endpoint: 1. Marks the task as deleted (is_deleted=True, deleted_at=now) 2. Permanently deletes all associated image files
For image-based tasks (EDITING, GENERATION, REFINE), this will permanently delete all files in: - editings/{task_id}/ for EDITING tasks - generations/{task_id}/ for GENERATION tasks - refines/{task_id}/ for REFINE tasks
The task record remains in the database for tracking and audit purposes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/tasks/{task_id}/cancel¶
Cancel Task
Description
Cancel a specific task.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/GenerationTaskPublic"
},
{
"$ref": "#/components/schemas/EditingTaskPublic"
},
{
"$ref": "#/components/schemas/RefineTaskPublic"
},
{
"$ref": "#/components/schemas/ExperimentalFalTaskPublic"
},
{
"$ref": "#/components/schemas/VideoGenerationTaskPublic"
},
{
"$ref": "#/components/schemas/LLMInteractionTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundRemovalTaskPublic"
},
{
"$ref": "#/components/schemas/DetailEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixTaskPublic"
},
{
"$ref": "#/components/schemas/ImageAdjusterTaskPublic"
},
{
"$ref": "#/components/schemas/FaceEnhancerTaskPublic"
},
{
"$ref": "#/components/schemas/SegmenterTaskPublic"
},
{
"$ref": "#/components/schemas/TransformationsSolverTaskPublic"
},
{
"$ref": "#/components/schemas/ImageTransformerTaskPublic"
},
{
"$ref": "#/components/schemas/BackgroundFixerTaskPublic"
},
{
"$ref": "#/components/schemas/CheckerTaskPublic"
}
],
"title": "Response Cancel Task"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/tasks/generation/{task_id}¶
Update Generation Task
Description
Update a generation task with generation-specific fields.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Request body
{
"status": null,
"priority": null,
"executor_type": null,
"executor_instance": null,
"errors": null,
"config": null,
"created_at": null,
"updated_at": null,
"task_type": null,
"origin_instance": null,
"origin_zone": null,
"origin_tenant_id": null,
"origin_reference": null,
"started_at": null,
"completed_at": null,
"celery_task_id": null,
"service_task_id": null,
"retry_count": null,
"progress": null,
"is_resumed": null,
"provider_type": null,
"active_provider_capabilities": null,
"queue_name": null,
"fallback_provider_type": null,
"fallback_provider_config": null,
"fallback_provider_capabilities": null,
"resume_attempt_count": null,
"last_resume_attempt": null,
"error_category": null,
"service_requests": null,
"fal_app_id": null,
"fal_request_id": null,
"subject_model_path": null,
"product_model_path": null,
"style_model_path": null,
"product2_model_path": null,
"subject_lora_weight": null,
"product_lora_weight": null,
"style_lora_weight": null,
"product2_lora_weight": null,
"reference_image_path": null,
"reference_image_strength": null,
"result_image_path": null
}
Schema of the request body
{
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskStatus"
},
{
"type": "null"
}
]
},
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Priority"
},
"executor_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Type"
},
"executor_instance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Instance"
},
"errors": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Errors"
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Config",
"description": "Flexible configuration storage"
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At",
"description": "Task creation timestamp"
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At",
"description": "Task last update timestamp"
},
"task_type": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskType"
},
{
"type": "null"
}
],
"description": "Task type"
},
"origin_instance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Instance",
"description": "Task origin instance"
},
"origin_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Zone",
"description": "Task origin zone"
},
"origin_tenant_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Tenant Id",
"description": "Task origin tenant ID"
},
"origin_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Reference",
"description": "Optional reference ID or string from the origin system"
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Started At",
"description": "Task start timestamp"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Completed At",
"description": "Task completion timestamp"
},
"celery_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Celery Task Id",
"description": "Task Celery task ID"
},
"service_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Task Id",
"description": "Task service task ID"
},
"retry_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Retry Count",
"description": "Task retry count"
},
"progress": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Progress",
"description": "Task progress (0.0 to 100.0)"
},
"is_resumed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Resumed",
"description": "Whether task is being resumed"
},
"provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
],
"description": "Provider type for task execution"
},
"active_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Active Provider Capabilities",
"description": "List of active capabilities for this task"
},
"queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queue Name",
"description": "Task queue name"
},
"fallback_provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
],
"description": "Fallback provider type"
},
"fallback_provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Fallback Provider Config",
"description": "Fallback provider-specific config"
},
"fallback_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fallback Provider Capabilities",
"description": "Fallback provider capabilities"
},
"resume_attempt_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Resume Attempt Count",
"description": "Number of resume attempts"
},
"last_resume_attempt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Resume Attempt",
"description": "Last resume attempt timestamp"
},
"error_category": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCategory"
},
{
"type": "null"
}
],
"description": "Error category classification"
},
"service_requests": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Service Requests",
"description": "External service request log for observability"
},
"fal_app_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal App Id",
"description": "FAL app ID"
},
"fal_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal Request Id",
"description": "FAL request ID"
},
"subject_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Model Path",
"description": "Path to the subject model"
},
"product_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Model Path",
"description": "Path to the product model"
},
"style_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Style Model Path",
"description": "Path to the style model"
},
"product2_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product2 Model Path",
"description": "Path to the second product model"
},
"subject_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Subject Lora Weight",
"description": "Subject LoRA weight"
},
"product_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product Lora Weight",
"description": "Product LoRA weight"
},
"style_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Style Lora Weight",
"description": "Style LoRA weight"
},
"product2_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product2 Lora Weight",
"description": "Second product LoRA weight"
},
"reference_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Image Path",
"description": "Path to the reference image"
},
"reference_image_strength": {
"anyOf": [
{
"type": "number",
"maximum": 100.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Reference Image Strength",
"description": "Influence of the reference image on generation (0-100)"
},
"result_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Result Image Path",
"description": "Path to the result image"
}
},
"type": "object",
"title": "GenerationTaskUpdate",
"description": "Schema for updating generation task fields"
}
Responses
{
"task_type": "string",
"priority": 0,
"config": null,
"origin_instance": "string",
"origin_zone": null,
"origin_tenant_id": null,
"origin_reference": null,
"id": "21b4e2d0-a7dc-44f4-94e8-411c752ce6db",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"started_at": null,
"completed_at": null,
"executor_type": null,
"executor_instance": null,
"celery_task_id": null,
"service_task_id": null,
"provider_type": null,
"active_provider_capabilities": null,
"fallback_provider_type": null,
"fallback_provider_config": null,
"fallback_provider_capabilities": null,
"errors": null,
"error_category": null,
"retry_count": 0,
"progress": 10.12,
"provider_config": null,
"subject_model_path": null,
"product_model_path": null,
"style_model_path": null,
"product2_model_path": null,
"subject_lora_weight": null,
"product_lora_weight": null,
"style_lora_weight": null,
"product2_lora_weight": null,
"workflow_id": null,
"prompt": null,
"width": null,
"height": null,
"seed": null,
"result_image_path": null,
"reference_image_path": null,
"reference_image_strength": null,
"fal_app_id": null,
"fal_request_id": null
}
Schema of the response body
{
"properties": {
"task_type": {
"type": "string",
"const": "GENERATION",
"title": "Task Type",
"default": "GENERATION"
},
"priority": {
"type": "integer",
"title": "Priority",
"description": "Task priority"
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Config"
},
"origin_instance": {
"type": "string",
"title": "Origin Instance",
"description": "Task origin instance"
},
"origin_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Zone",
"description": "Task origin zone"
},
"origin_tenant_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Tenant Id",
"description": "Task origin tenant ID"
},
"origin_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Reference",
"description": "Optional reference ID or string from the origin system"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"status": {
"$ref": "#/components/schemas/TaskStatus"
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Completed At"
},
"executor_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Type"
},
"executor_instance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Instance"
},
"celery_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Celery Task Id"
},
"service_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Task Id"
},
"provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"active_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Active Provider Capabilities"
},
"fallback_provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"fallback_provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Fallback Provider Config"
},
"fallback_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fallback Provider Capabilities"
},
"errors": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Errors"
},
"error_category": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCategory"
},
{
"type": "null"
}
]
},
"retry_count": {
"type": "integer",
"title": "Retry Count",
"default": 0
},
"progress": {
"type": "number",
"title": "Progress",
"default": 0.0
},
"provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Provider Config"
},
"subject_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Model Path"
},
"product_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Model Path"
},
"style_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Style Model Path"
},
"product2_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product2 Model Path"
},
"subject_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Subject Lora Weight"
},
"product_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product Lora Weight"
},
"style_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Style Lora Weight"
},
"product2_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product2 Lora Weight"
},
"workflow_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workflow Id"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"result_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Result Image Path"
},
"reference_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Image Path"
},
"reference_image_strength": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reference Image Strength"
},
"fal_app_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal App Id",
"description": "Get FAL app ID from provider config.",
"readOnly": true
},
"fal_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal Request Id",
"description": "Get FAL request ID from provider config.",
"readOnly": true
}
},
"type": "object",
"required": [
"priority",
"origin_instance",
"id",
"created_at",
"updated_at",
"status",
"fal_app_id",
"fal_request_id"
],
"title": "GenerationTaskPublic",
"description": "Public generation task schema for API responses"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/tasks/generation/{task_id}¶
Get Generation Task
Description
Get a specific generation task by ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
{
"task_type": "string",
"priority": 0,
"config": null,
"origin_instance": "string",
"origin_zone": null,
"origin_tenant_id": null,
"origin_reference": null,
"id": "ee689f9f-5d22-4b79-ad1b-90fc94ce66e9",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"started_at": null,
"completed_at": null,
"executor_type": null,
"executor_instance": null,
"celery_task_id": null,
"service_task_id": null,
"provider_type": null,
"active_provider_capabilities": null,
"fallback_provider_type": null,
"fallback_provider_config": null,
"fallback_provider_capabilities": null,
"errors": null,
"error_category": null,
"retry_count": 0,
"progress": 10.12,
"provider_config": null,
"subject_model_path": null,
"product_model_path": null,
"style_model_path": null,
"product2_model_path": null,
"subject_lora_weight": null,
"product_lora_weight": null,
"style_lora_weight": null,
"product2_lora_weight": null,
"workflow_id": null,
"prompt": null,
"width": null,
"height": null,
"seed": null,
"result_image_path": null,
"reference_image_path": null,
"reference_image_strength": null,
"fal_app_id": null,
"fal_request_id": null
}
Schema of the response body
{
"properties": {
"task_type": {
"type": "string",
"const": "GENERATION",
"title": "Task Type",
"default": "GENERATION"
},
"priority": {
"type": "integer",
"title": "Priority",
"description": "Task priority"
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Config"
},
"origin_instance": {
"type": "string",
"title": "Origin Instance",
"description": "Task origin instance"
},
"origin_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Zone",
"description": "Task origin zone"
},
"origin_tenant_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Tenant Id",
"description": "Task origin tenant ID"
},
"origin_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Reference",
"description": "Optional reference ID or string from the origin system"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"status": {
"$ref": "#/components/schemas/TaskStatus"
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Completed At"
},
"executor_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Type"
},
"executor_instance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Instance"
},
"celery_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Celery Task Id"
},
"service_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Task Id"
},
"provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"active_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Active Provider Capabilities"
},
"fallback_provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"fallback_provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Fallback Provider Config"
},
"fallback_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fallback Provider Capabilities"
},
"errors": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Errors"
},
"error_category": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCategory"
},
{
"type": "null"
}
]
},
"retry_count": {
"type": "integer",
"title": "Retry Count",
"default": 0
},
"progress": {
"type": "number",
"title": "Progress",
"default": 0.0
},
"provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Provider Config"
},
"subject_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Model Path"
},
"product_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Model Path"
},
"style_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Style Model Path"
},
"product2_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product2 Model Path"
},
"subject_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Subject Lora Weight"
},
"product_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product Lora Weight"
},
"style_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Style Lora Weight"
},
"product2_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product2 Lora Weight"
},
"workflow_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workflow Id"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"result_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Result Image Path"
},
"reference_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Image Path"
},
"reference_image_strength": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reference Image Strength"
},
"fal_app_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal App Id",
"description": "Get FAL app ID from provider config.",
"readOnly": true
},
"fal_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal Request Id",
"description": "Get FAL request ID from provider config.",
"readOnly": true
}
},
"type": "object",
"required": [
"priority",
"origin_instance",
"id",
"created_at",
"updated_at",
"status",
"fal_app_id",
"fal_request_id"
],
"title": "GenerationTaskPublic",
"description": "Public generation task schema for API responses"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/tasks/generation/{task_id}/cancel¶
Cancel Generation Task
Description
Cancel a specific generation task.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
task_id |
path | string | No |
Responses
{
"task_type": "string",
"priority": 0,
"config": null,
"origin_instance": "string",
"origin_zone": null,
"origin_tenant_id": null,
"origin_reference": null,
"id": "86015b37-7c5c-44ef-bb22-7b51916d8b36",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"started_at": null,
"completed_at": null,
"executor_type": null,
"executor_instance": null,
"celery_task_id": null,
"service_task_id": null,
"provider_type": null,
"active_provider_capabilities": null,
"fallback_provider_type": null,
"fallback_provider_config": null,
"fallback_provider_capabilities": null,
"errors": null,
"error_category": null,
"retry_count": 0,
"progress": 10.12,
"provider_config": null,
"subject_model_path": null,
"product_model_path": null,
"style_model_path": null,
"product2_model_path": null,
"subject_lora_weight": null,
"product_lora_weight": null,
"style_lora_weight": null,
"product2_lora_weight": null,
"workflow_id": null,
"prompt": null,
"width": null,
"height": null,
"seed": null,
"result_image_path": null,
"reference_image_path": null,
"reference_image_strength": null,
"fal_app_id": null,
"fal_request_id": null
}
Schema of the response body
{
"properties": {
"task_type": {
"type": "string",
"const": "GENERATION",
"title": "Task Type",
"default": "GENERATION"
},
"priority": {
"type": "integer",
"title": "Priority",
"description": "Task priority"
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Config"
},
"origin_instance": {
"type": "string",
"title": "Origin Instance",
"description": "Task origin instance"
},
"origin_zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Zone",
"description": "Task origin zone"
},
"origin_tenant_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Tenant Id",
"description": "Task origin tenant ID"
},
"origin_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Reference",
"description": "Optional reference ID or string from the origin system"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"status": {
"$ref": "#/components/schemas/TaskStatus"
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Completed At"
},
"executor_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Type"
},
"executor_instance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor Instance"
},
"celery_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Celery Task Id"
},
"service_task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Task Id"
},
"provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"active_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Active Provider Capabilities"
},
"fallback_provider_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ProviderType"
},
{
"type": "null"
}
]
},
"fallback_provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Fallback Provider Config"
},
"fallback_provider_capabilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fallback Provider Capabilities"
},
"errors": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Errors"
},
"error_category": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCategory"
},
{
"type": "null"
}
]
},
"retry_count": {
"type": "integer",
"title": "Retry Count",
"default": 0
},
"progress": {
"type": "number",
"title": "Progress",
"default": 0.0
},
"provider_config": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Provider Config"
},
"subject_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Model Path"
},
"product_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Model Path"
},
"style_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Style Model Path"
},
"product2_model_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product2 Model Path"
},
"subject_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Subject Lora Weight"
},
"product_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product Lora Weight"
},
"style_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Style Lora Weight"
},
"product2_lora_weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Product2 Lora Weight"
},
"workflow_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workflow Id"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"result_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Result Image Path"
},
"reference_image_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Image Path"
},
"reference_image_strength": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reference Image Strength"
},
"fal_app_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal App Id",
"description": "Get FAL app ID from provider config.",
"readOnly": true
},
"fal_request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fal Request Id",
"description": "Get FAL request ID from provider config.",
"readOnly": true
}
},
"type": "object",
"required": [
"priority",
"origin_instance",
"id",
"created_at",
"updated_at",
"status",
"fal_app_id",
"fal_request_id"
],
"title": "GenerationTaskPublic",
"description": "Public generation task schema for API responses"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schemas¶
BackgroundFixerTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_path |
||
mask_image_path |
||
node_params |
||
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
palette_image_path |
||
priority |
integer | Task priority |
progress |
number | |
protect_bbox |
||
provider_config |
||
provider_type |
||
result_image_path |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
target_rgb |
||
task_type |
string | |
updated_at |
string(date-time) |
BackgroundFixerTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
BackgroundFixStrategy¶
Type: string
BackgroundFixTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
base_image_path |
string | |
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
edge_blur_sigma |
DEPRECATED and ignored; superseded by inner/outer_blur_sigma. | |
error_category |
||
errors |
||
exclude |
DEPRECATED and ignored; retained for backward compatibility. | |
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
inner_blur_sigma |
||
light_threshold |
||
mask_palettes |
DEPRECATED and ignored; per-region palette overrides are no longer supported. | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
outer_blur_sigma |
||
palette_image_path |
string | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
result_image_path |
||
retry_count |
integer | |
service_task_id |
||
shadow_threshold |
||
started_at |
||
status |
TaskStatus | |
strategy |
BackgroundFixStrategy | |
task_type |
string | |
updated_at |
string(date-time) |
BackgroundFixTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
BackgroundRemovalTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_paths |
Array<string> | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
result_image_paths |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
BackgroundRemovalTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
CheckerTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
base_bboxes |
||
base_image_path |
||
base_mask_path |
||
bboxes |
||
candidate_image_path |
||
candidate_mask_path |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
diagnostics |
||
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
passed |
||
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
reference_details |
||
report |
||
retry_count |
integer | |
service_task_id |
||
shot_type |
||
started_at |
||
status |
TaskStatus | |
summary |
||
task_type |
string | |
updated_at |
string(date-time) |
CheckerTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
CreateBackgroundFixerTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image |
string | Input image as base64, data URL, local path, or remote URL |
mask_image |
Mask image (base64, data URL, local path, or remote URL), typically fanned out from an upstream SEGMENTER's result_mask_path. Required by every node; 255 = subject, the same convention every mask producer in this codebase emits. Passed through as-is. | |
node_params |
Per-node tuning knobs (one blob; each node self-extracts its own keys). shift_color: shadow_threshold, light_threshold, dither. replace_color: bbox_enlargement, bbox_blur_sigma, dither. heal_artifacts: sigma, bayesshrink_k, garrote_strength. All nodes: mask_kind ('soft'|'binary'). | |
node_type |
string | Which node executes this task: 'shift_color' / 'replace_color' (color ops toward a target) or 'heal_artifacts' (frequency-separation artifact removal). All LOCAL. |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
palette_image |
Optional palette image whose whole-image mean RGB is the shift target for shift_color / replace_color (an alternative to the scalar target_rgb). Ignored by heal_artifacts. | |
priority |
integer | |
protect_bbox |
Relative bbox [x, y, width, height] (0-1), or a list of such bboxes whose first item is used, that replace_color must NOT substitute. Typically wired from an upstream SEGMENTER detect node's bboxes output. None -> the whole background is substituted. An empty bbox list is treated as None. Unused by the other nodes. | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
target_rgb |
Scalar target color [r, g, b] (0-255) for shift_color / replace_color. Takes precedence over palette_image when both are provided. | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateBackgroundFixTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
base_image |
string | Base image as base64, data URL (data:image/...), remote URL (http://...), or local path |
config |
Flexible configuration storage | |
edge_blur_sigma |
DEPRECATED and ignored. Superseded by inner_blur_sigma / outer_blur_sigma. Retained for backward compatibility; has no effect. | |
exclude |
DEPRECATED and ignored. The DEFAULT strategy always protects the foreground subject via BiRefNet (SAM-3 fallback). Retained for backward compatibility; has no effect and will be removed in a future version. | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
inner_blur_sigma |
Gaussian sigma for inner edge inward gradient. DEFAULT strategy only. | |
light_threshold |
Brightness above which full color shift applied (0-255, default 220) | |
mask_palettes |
DEPRECATED and ignored. The DEFAULT strategy applies a single palette to the resolved background; per-region palette overrides are no longer supported. Retained for backward compatibility; has no effect and will be removed in a future version. | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
outer_blur_sigma |
Gaussian sigma for outer edge outward gradient. DEFAULT strategy only. | |
palette_image |
string | Palette/reference image for target background color as base64, data URL, remote URL, or local path |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
shadow_threshold |
Brightness below which no color shift applied (0-255, default 150) | |
strategy |
Processing strategy | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateBackgroundRemovalTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image_paths |
Array<string> | List of image paths or URLs for batch background removal |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateCheckerTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
base_bboxes |
check_product only: relative [x, y, width, height] regions of the REFERENCE still-life to judge — wire a separate Moondream detect step's `bboxes` here. The node unions these boxes and crops only the reference; omit to judge the full still-life. | |
base_image |
Reference image (base64, data URL, local path, or remote URL): the styled base for check_identity/check_proportions or the product still-life for check_product. | |
base_mask |
check_product only: subject matte for the REFERENCE still-life (255 = subject) — wire an upstream mask step's `result_mask_path` here. Supplied together with `candidate_mask`, it enables a numeric garment colour measurement (ΔE00) alongside the VLM verdict. Omit both to skip the measurement. | |
bboxes |
Relative [x, y, width, height] regions of the candidate to judge — wire an upstream detect step's `bboxes` here. check_identity and check_product judge a single crop and use the union of these boxes; omit to judge the whole frame. | |
candidate_image |
Candidate shot to verify against the base (base64, data URL, local path, or remote URL). | |
candidate_mask |
check_product: subject matte for the CANDIDATE shot (255 = subject) — wire an upstream mask step's `result_mask_path` here. check_margins: final subject mask aligned to the delivered image. | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
margin_bottom |
check_margins bottom target as a final-height fraction. | |
margin_left |
check_margins left target as a final-width fraction. | |
margin_right |
check_margins right target as a final-width fraction. | |
margin_top |
check_margins top target as a final-height fraction. | |
node_type |
string | Which node executes this task: 'check_identity' (VLM same-person verdict), 'check_product' (VLM product fidelity verdict), 'check_proportions' (VLM body, hand, and foot proportion verdicts), 'check_margins' (LOCAL numeric final margins from a candidate mask), or 'aggregate_checks' (LOCAL deterministic aggregation). |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
reference_details |
check_product only: a described inventory of the marks and fittings the REFERENCE garment carries, as [{box, kind, text}] — wire an upstream detect step's `description` here, running the 'gemini' strategy on the still-life. Pasted into the matching aspect prompts so those calls know which small details exist to look for. The boxes are in the full reference frame, are never used to crop, and are remapped to the checker reference crop only when included in a prompt. Omit to judge exactly as before. | |
reports |
aggregate_checks only: ordered checker reports to concatenate. | |
shot_type |
check_margins only: shot-type policy. 'detail' skips the margin check (returns a neutral passing report) because margins are intentionally ignored for detail shots. Ignored by other checker nodes. | |
target |
Stable key and display label for the subject or product being assessed. | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateDetailEnhancerTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
base_image |
string | Base image as base64, data URL (data:image/...), or remote URL (http://...) |
config |
Flexible configuration storage | |
detail_label |
Type of detail to enhance (e.g., tshirt, shirt, pants, logos) | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
reference_image |
string | Reference image for detail transfer as base64, data URL, or remote URL |
task_type |
string | |
webhook_url |
Webhook URL |
CreateEditingTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
base_image |
string | Base image as base64, data URL (data:image/...), or remote URL (http://...) |
base_image_data |
DEPRECATED: Use base_image instead. Base64-encoded base image data. | |
base_image_url |
DEPRECATED: Use base_image instead. URL to base image file. | |
config |
Flexible configuration storage | |
fal_app_id |
FAL app ID for task execution | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
height |
integer | Image height |
node_type |
Which EDITING node executes this task. None (default) runs the legacy provider processors; 'preview_edit' runs the light, disposable preview node. | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
prompt |
string | Task prompt |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
reference_image_data |
DEPRECATED: Use reference_images instead. Base64-encoded reference image data. | |
reference_image_url |
DEPRECATED: Use reference_images instead. URL to reference image file. | |
reference_images |
List of reference images (base64, data URLs, or remote URLs) | |
seed |
Random seed for generation | |
task_type |
string | |
webhook_url |
Webhook URL | |
width |
integer | Image width |
workflow_id |
Workflow ID |
CreateExperimentalFalTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fal_app_id |
string | FAL app ID for task execution |
fal_parameters |
Arbitrary parameters to pass to the FAL app | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateFaceEnhancerTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image |
string | Input image as base64, data URL (data:image/...), or remote URL (http://...) |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateGenerationTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fal_app_id |
FAL app ID for task execution | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
height |
Image height | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
product2_lora_weight |
Second product LoRA weight | |
product2_model_path |
Path to the second product model | |
product_lora_weight |
Product LoRA weight | |
product_model_path |
Path to the product model | |
prompt |
string | Task prompt |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
reference_image_data |
Base64-encoded reference image data (data:image/jpeg;base64,... format) | |
reference_image_strength |
Influence of the reference image on generation (0-100) | |
reference_image_url |
URL to reference image file | |
seed |
Random seed for generation | |
style_lora_weight |
Style LoRA weight | |
style_model_path |
Path to the style model | |
subject_lora_weight |
Subject LoRA weight | |
subject_model_path |
Path to the subject model | |
task_type |
string | |
webhook_url |
Webhook URL | |
width |
Image width |
CreateImageAdjusterTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
aspect_ratio |
Target aspect ratio (width/height). Use either this or target_width/target_height. | |
bbox_height |
Subject bbox height (relative 0-1) | |
bbox_width |
Subject bbox width (relative 0-1) | |
bbox_x |
Subject bbox left edge (relative 0-1) | |
bbox_y |
Subject bbox top edge (relative 0-1) | |
config |
Flexible configuration storage | |
cropping_position |
Position to crop from (only used when mode='crop') | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image |
string | Input image as base64, data URL (data:image/...), remote URL (http://...), or local path |
margin_bottom |
Bottom margin as fraction of final height (0.0-1.0). 0 enforces 0 (subject touches bottom); >0 enforces exactly; None preserves the input's natural bottom margin. Subject detection required. | |
margin_left |
Left margin as fraction of final width (0.0-1.0). 0 enforces 0 (subject touches left); >0 enforces exactly; None preserves the input's natural left margin. Subject detection required. | |
margin_right |
Right margin as fraction of final width (0.0-1.0). 0 enforces 0 (subject touches right); >0 enforces exactly; None preserves the input's natural right margin. Subject detection required. | |
margin_top |
Top margin as fraction of final height (0.0-1.0). 0 enforces 0 (subject touches top); >0 enforces exactly; None preserves the input's natural top margin. Subject detection required. | |
mode |
string | Resize mode: 'auto' intelligently chooses crop or pad based on AR difference (>5% diff = pad to preserve content, <=5% = crop for minimal loss), 'crop' removes pixels, 'pad' adds padding, 'scale' resizes based on proportions |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
reference_image |
Optional reference image used to derive subject margins automatically (base64, data URL, remote URL, or local path). | |
resampling |
Resampling filter to use | |
scaling_proportions |
Scaling proportions mode. 'height' matches vertical (top/bottom) margins exactly (may crop horizontally); 'width' matches horizontal (left/right) margins exactly (may crop vertically); 'auto' selects height or width by which margin pair the subject reaches first when scaled into the target canvas+margins (enforces that first-touched pair; portrait canvases usually resolve to 'width'). 'height'/'width'/'auto' apply only on the margin-aware path (margins set or reference mode); otherwise they fall back to 'fit'. | |
subject_mask_path |
Subject mask (white=subject) from an upstream SEGMENTER step. If omitted, the processor falls back to in-process BiRefNet segmentation. | |
target_height |
Target height in pixels (required if target_width is set) | |
target_width |
Target width in pixels (required if target_height is set) | |
task_type |
string | |
tolerance |
Tolerance for checking if adjustment is needed (0-1, default 0% for pixel-perfect) | |
webhook_url |
Webhook URL |
CreateImageTransformerTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image |
string | Input image as base64, data URL, local path, or remote URL |
mask_image |
Subject-mask image (base64, data URL, local path, or remote URL) for the OUTPAINT node (VERTEX), typically fanned out from an upstream SEGMENTER's result_mask_path. Required by OUTPAINT for subject-alpha paste-back and Voronoi safety censorship when any solver pad is non-zero; a zero-pad plan passes the input through without loading the mask. Unused by the LOCAL pad/crop/scale nodes. | |
max_regions |
For the crop_regions node: cut at most this many regions, keeping the first N in the order given. A BUDGET, not a safety limit (the node keeps its own hard ceiling for detector artefacts): a reference set has a useful size, and past it each extra crop dilutes the attention a consumer pays to the others. Omit to cut them all. | |
min_edge_px |
For the crop_regions node: shortest edge a crop is upscaled to when it lands below it. Upscaling adds no information — it exists for consumers that reject or under-weight small inputs. Omit to keep every crop at native resolution. | |
node_type |
string | Which transformer node executes this task: pad/crop/scale/crop_regions (LOCAL) or outpaint (VERTEX). Provider defaults from the node when omitted. |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
pad_color |
Solid RGB fill [r, g, b] (0-255) for the pad node; defaults to white when omitted | |
padding_ratio |
For the crop_regions node: fraction of each box's own width/height added per side, clamped to the frame. A box that hugs its subject cuts away the surrounding context; how much context is worth keeping is the caller's policy. Defaults to 0.0 (cut the box as given). | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
regions |
For the crop_regions node: the regions to cut, as [{box: [x, y, width, height], ...}]. Only `box` is interpreted and every other key is ignored, so a detector's rich per-item output can be wired straight in. COORDINATE FRAME: boxes are relative to `input_image` — boxes detected on a different frame cut the wrong regions. | |
result_transform |
PAD->CROP->SCALE plan from TRANSFORMATIONS_SOLVER. Each node reads its own sub-key: the pad node reads 'pad' and the crop node reads 'crop' (pixel amounts per side), the scale node reads 'scale' (uniform float factor). The OUTPAINT node passes input_image through unchanged when every 'pad' amount is zero; otherwise it takes its subject mask from the separate 'mask_image' input. | |
target_height |
Exact output height for the scale node; omitted keeps scale-factor-derived sizing. | |
target_width |
Exact output width for the scale node; omitted keeps scale-factor-derived sizing. | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateLLMInteractionTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
config |
Flexible configuration storage | |
details |
compose_prompt only: detail descriptions aligned with the crops the renderer receives, as [{kind, text}, ...]. Stored on the task's inputs JSONB port. | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_images |
List of image paths/URLs | |
node_type |
Which node executes this task: 'caption' (VERTEX image -> short label, fixed prompt) or 'compose_prompt' (LOCAL text join of the authored prompt and crop detail descriptions). Omit for the legacy ai_core free-prompt path. | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
prompt |
User prompt. Required for the legacy path and compose_prompt; caption carries a fixed prompt. | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
system_prompt |
System prompt | |
task_type |
TaskType | |
webhook_url |
Webhook URL |
CreateRefineTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
base_image_url |
string | Base image URL |
config |
Flexible configuration storage | |
face_detail_denoise |
number | Denoise strength |
face_detail_enabled |
boolean | Whether to enhance face details in the image |
face_detail_prompt |
Face detail prompt | |
face_detail_seed |
Seed for the face detail enhancement | |
face_detail_steps |
integer | Number of inference steps |
fal_app_id |
FAL app ID for task execution | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
target_height |
Target output height in pixels | |
target_width |
Target output width in pixels | |
task_type |
string | |
upscale_denoise |
number | Denoise strength |
upscale_enabled |
boolean | Whether to upscale the image |
upscale_factor |
Upscale factor (float value). Integer values 2, 4, 8 use specific UPSCALE_*X capabilities. Non-integer values require UPSCALE_FLOAT capability. If not provided, OUTPUT_SIZE capability is required | |
upscale_prompt |
Task prompt | |
upscale_seed |
Seed for the upscale | |
upscale_steps |
integer | Number of inference steps |
webhook_url |
Webhook URL |
CreateSegmenterTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
backend |
Deprecated alias of 'strategy' (kept for pre-rename clients). Ignored when 'strategy' is provided; passing both with different values is a 422. | |
cca |
boolean | Keep only the largest connected component (SAM-3 only; ignored for strategy='birefnet') |
config |
Flexible configuration storage | |
fallback_prompts |
Array<string> | Alternative prompts tried IN ORDER when 'prompt' detects nothing or SAM-3 produces no mask; the first that hits wins. Empty (default) = single attempt. Bounded because each entry costs a separate billable vendor round-trip. |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
holes_filling_percent |
Fill enclosed holes smaller than X% of image area; null disables (SAM-3 only; ignored for strategy='birefnet') | |
input_image |
string | Input image as base64, data URL (data:image/...), or remote URL (http://...) |
invert_mask |
boolean | Invert the returned mask (SAM-3 only; ignored for strategy='birefnet') |
max_masks |
integer | Number of masks to return (SAM-3 only; ignored for strategy='birefnet') |
node_type |
Which segmenter node executes this task: 'mask' (SAM-3/BiRefNet mask, default) or 'detect' (Moondream3 bounding box). | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
prompt |
What to segment/detect (e.g. 'human person', 'background'). Required for prompt-guided strategies (sam3, moondream); ignored by fixed-scaffold strategies (birefnet, gemini_product_inventory, gemini_graphics). | |
provider_config |
FAL segmenter provider configuration. | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
return_bboxes |
boolean | Derive bounding box(es) from the resulting mask |
strategy |
Algorithm for the selected node: 'birefnet' (soft matte, default) or 'sam3' (binary mask) for node_type='mask'; 'moondream' (default) or 'gemini' for node_type='detect'. 'gemini' is the odd one out: it runs on VERTEX (provider_type is pinned for you) and returns a DESCRIBED inventory of the marks and fittings it finds, not just boxes. A strategy set in FAL_SEGMENTER provider_config takes precedence for node_type='mask'. Defaults per node when neither this nor the deprecated 'backend' alias is provided. | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateTransformationsSolverTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
bbox_height |
Subject bbox height (relative 0-1) | |
bbox_width |
Subject bbox width (relative 0-1) | |
bbox_x |
Subject bbox left edge (relative 0-1) | |
bbox_y |
Subject bbox top edge (relative 0-1) | |
config |
Flexible configuration storage | |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image |
string | Input image as base64, data URL (data:image/...), remote URL (http://...), or local path |
margin_bottom |
Bottom margin as fraction of final height (0.0-1.0). 0 enforces 0 (subject touches bottom); >0 enforces exactly; None preserves the input's natural bottom margin. | |
margin_left |
Left margin as fraction of final width (0.0-1.0). 0 enforces 0 (subject touches left); >0 enforces exactly; None preserves the input's natural left margin. | |
margin_right |
Right margin as fraction of final width (0.0-1.0). 0 enforces 0 (subject touches right); >0 enforces exactly; None preserves the input's natural right margin. | |
margin_strategy |
string | Margin-processing priority, used only when margins are given. 'vertical' pins top+bottom (scale by scale_h); 'horizontal' pins left+right (scale by scale_w); 'auto' picks the pair the subject reaches first (scale_w < scale_h -> horizontal, else vertical, tie -> vertical). |
margin_tolerance |
number | Absolute per-side difference accepted as already matching an explicit margin target. For example, 0.005 means 0.5 percentage points. |
margin_top |
Top margin as fraction of final height (0.0-1.0). 0 enforces 0 (subject touches top); >0 enforces exactly; None preserves the input's natural top margin. | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
placement_strategy |
string | No-margins placement: 'preserve' keeps the subject center at its original fraction p; 'center' lands it at 0.5 (clamped). Requires a bbox. The solver auto-decides crop-to-AR (if it would not cut the subject) vs pad-to-AR; there is no pad/crop input. |
priority |
integer | |
protected_bboxes |
Relative [x, y, width, height] boxes of writings/logos/graphics the detail crop must not cut. Ignored when shot_type != 'detail'. | |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
shot_type |
Shot-type policy. 'detail' forces crop/scale only (pad=0, OUTPAINT short-circuited) and ignores margins. Any other value (full_body, upper_body, ...) is accepted but has no effect yet; None keeps legacy. | |
target_height |
Target height in pixels (required, paired with target_width) | |
target_width |
Target width in pixels (required, paired with target_height) | |
task_type |
string | |
webhook_url |
Webhook URL |
CreateVideoGenerationTask¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
cfg_scale |
number | Classifier-free guidance scale (0.0-2.0) |
config |
Flexible configuration storage | |
duration_seconds |
integer | Video duration in seconds (1-60) |
fallback_provider_capabilities |
Capabilities for the fallback provider. Replaces active_provider_capabilities on fallback activation. | |
fallback_provider_config |
Provider-specific config for the fallback provider. Shape varies by provider type. | |
fallback_provider_type |
Fallback provider activated when primary exhausts all retries (non-ValueError only). | |
input_image_data |
Base64-encoded input image data (data:image/jpeg;base64,... format) | |
input_image_url |
URL to input image for video generation | |
negative_prompt |
Negative prompt to avoid unwanted elements | |
origin_instance |
string | Identifier for the instance that created this task |
origin_reference |
Optional field that can be used to map an id or a reference string from the origin (such as prediction id in the external backend) | |
origin_tenant_id |
Optional tenant/organization identifier | |
origin_zone |
Environment/zone identifier (e.g., 'eu', 'us') | |
priority |
integer | |
prompt |
string | Text prompt describing the desired video content |
provider_config |
Provider-specific configuration | |
provider_type |
Provider type for task execution | |
queue_name |
Optional queue override. If not specified, determined by provider_type | |
task_type |
string | |
webhook_url |
Webhook URL |
DetailEnhancerTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
base_image_path |
string | |
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
detail_label |
||
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
fallback_used |
boolean | |
id |
string(uuid) | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
reference_image_path |
string | |
result_image_path |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
DetailEnhancerTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
EditingTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
base_image_path |
string | |
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fal_app_id |
Get FAL app ID from provider config. | |
fal_request_id |
Get FAL request ID from provider config. | |
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
height |
integer | |
id |
string(uuid) | |
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
prompt |
string | |
provider_config |
||
provider_type |
||
reference_image_path |
||
reference_images |
||
result_image_path |
||
retry_count |
integer | |
seed |
||
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) | |
width |
integer | |
workflow_id |
Workflow ID |
EditingTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
ErrorCategory¶
Type: string
ExperimentalFalTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fal_app_id |
string | FAL app ID for task execution |
fal_parameters |
Parameters passed to the FAL app | |
fal_request_id |
FAL request ID | |
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
result_url |
URL of the result from FAL | |
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
ExperimentalFalTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
fal_app_id |
FAL app ID for task execution | |
fal_parameters |
Parameters to pass to the FAL app | |
priority |
||
status |
FaceEnhancerTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
attempts_used |
integer | |
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
face_detected |
boolean | |
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
fallback_used |
boolean | |
final_dists_score |
||
final_lpips_score |
||
final_ssim_score |
||
id |
string(uuid) | |
input_image_path |
string | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
result_image_path |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
FaceEnhancerTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
FalSegmenterConfig¶
| Name | Type | Description |
|---|---|---|
backend |
string | Deprecated alias of 'strategy'; kept (with its default) for back-compat. |
provider_type |
string | |
strategy |
Segmentation strategy used by the provider (preferred over 'backend'). |
GenerationTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fal_app_id |
Get FAL app ID from provider config. | |
fal_request_id |
Get FAL request ID from provider config. | |
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
height |
||
id |
string(uuid) | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
product2_lora_weight |
||
product2_model_path |
||
product_lora_weight |
||
product_model_path |
||
progress |
number | |
prompt |
||
provider_config |
||
provider_type |
||
reference_image_path |
||
reference_image_strength |
||
result_image_path |
||
retry_count |
integer | |
seed |
||
service_task_id |
||
started_at |
||
status |
TaskStatus | |
style_lora_weight |
||
style_model_path |
||
subject_lora_weight |
||
subject_model_path |
||
task_type |
string | |
updated_at |
string(date-time) | |
width |
||
workflow_id |
GenerationTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
GenerationTaskUpdate¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
celery_task_id |
Task Celery task ID | |
completed_at |
Task completion timestamp | |
config |
Flexible configuration storage | |
created_at |
Task creation timestamp | |
error_category |
Error category classification | |
errors |
||
executor_instance |
||
executor_type |
||
fal_app_id |
FAL app ID | |
fal_request_id |
FAL request ID | |
fallback_provider_capabilities |
Fallback provider capabilities | |
fallback_provider_config |
Fallback provider-specific config | |
fallback_provider_type |
Fallback provider type | |
is_resumed |
Whether task is being resumed | |
last_resume_attempt |
Last resume attempt timestamp | |
origin_instance |
Task origin instance | |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
||
product2_lora_weight |
Second product LoRA weight | |
product2_model_path |
Path to the second product model | |
product_lora_weight |
Product LoRA weight | |
product_model_path |
Path to the product model | |
progress |
Task progress (0.0 to 100.0) | |
provider_type |
Provider type for task execution | |
queue_name |
Task queue name | |
reference_image_path |
Path to the reference image | |
reference_image_strength |
Influence of the reference image on generation (0-100) | |
result_image_path |
Path to the result image | |
resume_attempt_count |
Number of resume attempts | |
retry_count |
Task retry count | |
service_requests |
External service request log for observability | |
service_task_id |
Task service task ID | |
started_at |
Task start timestamp | |
status |
||
style_lora_weight |
Style LoRA weight | |
style_model_path |
Path to the style model | |
subject_lora_weight |
Subject LoRA weight | |
subject_model_path |
Path to the subject model | |
task_type |
Task type | |
updated_at |
Task last update timestamp |
HTTPValidationError¶
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
ImageAdjusterTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
aspect_ratio |
||
bbox_height |
||
bbox_width |
||
bbox_x |
||
bbox_y |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
cropping_position |
||
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_path |
string | |
margin_bottom |
||
margin_left |
||
margin_right |
||
margin_top |
||
mode |
string | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
reference_image_path |
||
resampling |
||
result_image_path |
||
retry_count |
integer | |
scaling_proportions |
||
service_task_id |
||
started_at |
||
status |
TaskStatus | |
subject_mask_path |
||
target_height |
||
target_width |
||
task_type |
string | |
tolerance |
||
updated_at |
string(date-time) |
ImageAdjusterTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
ImageTransformerTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
crop_paths |
||
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_path |
||
mask_image_path |
||
max_regions |
||
min_edge_px |
||
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
pad_color |
||
padding_ratio |
||
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
regions |
||
result_image_path |
||
result_transform |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
ImageTransformerTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
LLMInteractionTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_images |
||
input_tokens |
||
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
output_tokens |
||
priority |
integer | Task priority |
progress |
number | |
prompt |
string | |
provider_config |
||
provider_type |
||
result_text |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
system_prompt |
||
task_type |
TaskType | Task type |
updated_at |
string(date-time) |
LLMInteractionTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
List of active capabilities for this task | |
celery_task_id |
Task Celery task ID | |
completed_at |
Task completion timestamp | |
config |
Flexible configuration storage | |
created_at |
Task creation timestamp | |
error_category |
Error category classification | |
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
Fallback provider capabilities | |
fallback_provider_config |
Fallback provider-specific config | |
fallback_provider_type |
Fallback provider type | |
is_resumed |
Whether task is being resumed | |
last_resume_attempt |
Last resume attempt timestamp | |
origin_instance |
Task origin instance | |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
||
progress |
||
provider_type |
Provider type for task execution | |
queue_name |
Task queue name | |
resume_attempt_count |
Number of resume attempts | |
retry_count |
Task retry count | |
service_requests |
External service request log for observability | |
service_task_id |
Task service task ID | |
started_at |
Task start timestamp | |
status |
||
task_type |
Task type | |
updated_at |
Task last update timestamp |
ProviderCapability¶
Type: string
ProviderType¶
Type: string
QaAssessment-Input¶
| Name | Type | Description |
|---|---|---|
checks |
Array<QaCheck> | |
key |
string | |
label |
string | |
passed |
boolean | |
target |
QaTarget |
QaAssessment-Output¶
| Name | Type | Description |
|---|---|---|
checks |
Array<QaCheck> | |
key |
string | |
label |
string | |
passed |
boolean | |
target |
QaTarget |
QaCheck¶
| Name | Type | Description |
|---|---|---|
key |
string | |
label |
string | |
locations |
Array<QaLocation> | |
passed |
boolean | |
reasoning |
string |
QaLocation¶
| Name | Type | Description |
|---|---|---|
x_max |
number | |
x_min |
number | |
y_max |
number | |
y_min |
number |
QaReport-Input¶
| Name | Type | Description |
|---|---|---|
assessments |
Array<QaAssessment-Input> | |
passed |
boolean | |
schema_version |
integer | |
summary |
string |
QaReport-Output¶
| Name | Type | Description |
|---|---|---|
assessments |
Array<QaAssessment-Output> | |
passed |
boolean | |
schema_version |
integer | |
summary |
string |
QaTarget¶
| Name | Type | Description |
|---|---|---|
key |
string | |
label |
string |
RefineTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
face_detail_denoise |
number | |
face_detail_seed |
integer | |
face_detail_steps |
integer | |
fal_app_id |
Get FAL app ID from provider config. | |
fal_request_id |
Get FAL request ID from provider config. | |
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
provider_config |
||
provider_type |
||
result_image_path |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
target_height |
||
target_width |
||
task_type |
string | |
updated_at |
string(date-time) | |
upscale_denoise |
number | |
upscale_factor |
||
upscale_seed |
integer | |
upscale_steps |
integer |
RefineTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
SegmenterTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
additional_mask_paths |
||
backend |
string | |
bbox_height |
||
bbox_width |
||
bbox_x |
||
bbox_y |
||
cca |
boolean | |
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_prompts |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
holes_filling_percent |
||
id |
string(uuid) | |
input_image_path |
string | |
invert_mask |
boolean | |
mask_kind |
||
mask_url |
||
max_masks |
integer | |
node_type |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
prompt |
||
provider_config |
||
provider_type |
||
result_mask_path |
||
retry_count |
integer | |
return_bboxes |
boolean | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
strategy |
string | |
task_type |
string | |
updated_at |
string(date-time) |
SegmenterTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
TaskStatus¶
Type: string
TaskType¶
Type: string
TransformationsSolverTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
bbox_height |
||
bbox_width |
||
bbox_x |
||
bbox_y |
||
celery_task_id |
||
completed_at |
||
config |
||
created_at |
string(date-time) | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_path |
string | |
margin_bottom |
||
margin_left |
||
margin_right |
||
margin_strategy |
string | |
margin_tolerance |
number | |
margin_top |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
placement_strategy |
string | |
priority |
integer | Task priority |
progress |
number | |
protected_bboxes |
||
provider_config |
||
provider_type |
||
result_transform |
||
retry_count |
integer | |
service_task_id |
||
shot_type |
||
started_at |
||
status |
TaskStatus | |
target_height |
||
target_width |
||
task_type |
string | |
updated_at |
string(date-time) |
TransformationsSolverTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
ValidationError¶
| Name | Type | Description |
|---|---|---|
loc |
Array<> | |
msg |
string | |
type |
string |
VideoGenerationTaskPublic¶
| Name | Type | Description |
|---|---|---|
active_provider_capabilities |
||
celery_task_id |
||
cfg_scale |
number | |
completed_at |
||
config |
||
created_at |
string(date-time) | |
duration_seconds |
integer | |
error_category |
||
errors |
||
executor_instance |
||
executor_type |
||
fallback_provider_capabilities |
||
fallback_provider_config |
||
fallback_provider_type |
||
id |
string(uuid) | |
input_image_path |
string | |
negative_prompt |
||
origin_instance |
string | Task origin instance |
origin_reference |
Optional reference ID or string from the origin system | |
origin_tenant_id |
Task origin tenant ID | |
origin_zone |
Task origin zone | |
priority |
integer | Task priority |
progress |
number | |
prompt |
string | |
provider_config |
||
provider_type |
||
result_video_path |
||
retry_count |
integer | |
service_task_id |
||
started_at |
||
status |
TaskStatus | |
task_type |
string | |
updated_at |
string(date-time) |
VideoGenerationTaskPublicUpdate¶
| Name | Type | Description |
|---|---|---|
config |
||
errors |
||
executor_instance |
||
executor_type |
||
priority |
||
status |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| HTTPBearer | http | bearer |