Generation Models Endpoints

Generation Models API endpoints.

---

Overview

Method	Endpoint	Description
GET	/api/v1/generation-models/	Read Generation Models
POST	/api/v1/generation-models/	Create Generation Model
GET	/api/v1/generation-models/{id}	Read Generation Model
PUT	/api/v1/generation-models/{id}	Update Generation Model
DELETE	/api/v1/generation-models/{id}	Delete Generation Model

---

API Reference

Sartiq Backend Server - Generation Models 0.1.0

generation-models

---

GET /api/v1/generation-models/

Read Generation Models

Description

Retrieve generation models. Public endpoint.

Input parameters

Parameter	In	Type	Default	Nullable	Description
limit	query	integer	100	No
skip	query	integer	0	No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "data": [
        {
            "id": "9abf05a6-e03e-4998-aec8-f365e84e4331",
            "name": "string",
            "icon": null,
            "provider": "fal_standard",
            "provider_config": null,
            "provider_capabilities": null,
            "fallback_provider": null,
            "fallback_provider_config": null,
            "fallback_provider_capabilities": null,
            "tool_types": [
                "BASE_GENERATION"
            ],
            "recommended": true,
            "beta": true,
            "max_output_width": null,
            "max_output_height": null,
            "max_size_pixels": null
        }
    ],
    "count": 0
}

⚠️ 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

{
    "properties": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/GenerativeModelsPublic"
            },
            "type": "array",
            "title": "Data"
        },
        "count": {
            "type": "integer",
            "title": "Count"
        }
    },
    "type": "object",
    "required": [
        "data",
        "count"
    ],
    "title": "GenerativeModelsListPublic",
    "description": "Schema for list of generation models."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ 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

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/v1/generation-models/

Create Generation Model

Description

Create new generation model. Admin only.

Input parameters

Parameter	In	Type	Default	Nullable	Description
OAuth2PasswordBearer	header	string	N/A	No

Request body

application/json

{
    "name": "string",
    "icon": null,
    "provider": "fal_standard",
    "provider_config": null,
    "provider_capabilities": null,
    "fallback_provider": null,
    "fallback_provider_config": null,
    "fallback_provider_capabilities": null,
    "tool_types": [
        "BASE_GENERATION"
    ],
    "recommended": true,
    "beta": true,
    "max_output_width": null,
    "max_output_height": null,
    "max_size_pixels": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "name": {
            "type": "string",
            "title": "Name"
        },
        "icon": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Icon"
        },
        "provider": {
            "$ref": "#/components/schemas/ProviderType"
        },
        "provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                }
            ],
            "title": "Provider Config"
        },
        "provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Capabilities"
        },
        "fallback_provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "fallback_provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Config"
        },
        "fallback_provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Capabilities"
        },
        "tool_types": {
            "items": {
                "$ref": "#/components/schemas/GenerationTool"
            },
            "type": "array",
            "title": "Tool Types",
            "default": []
        },
        "recommended": {
            "type": "boolean",
            "title": "Recommended",
            "default": false
        },
        "beta": {
            "type": "boolean",
            "title": "Beta",
            "default": false
        },
        "max_output_width": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Width"
        },
        "max_output_height": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Height"
        },
        "max_size_pixels": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Size Pixels"
        }
    },
    "type": "object",
    "required": [
        "name",
        "provider",
        "provider_config"
    ],
    "title": "GenerativeModelsCreate",
    "description": "Schema for creating a new generation model."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "719197d5-4c69-45c4-b6c3-59eff241f8f3",
    "name": "string",
    "icon": null,
    "provider": "fal_standard",
    "provider_config": null,
    "provider_capabilities": null,
    "fallback_provider": null,
    "fallback_provider_config": null,
    "fallback_provider_capabilities": null,
    "tool_types": [
        "BASE_GENERATION"
    ],
    "recommended": true,
    "beta": true,
    "max_output_width": null,
    "max_output_height": null,
    "max_size_pixels": null
}

⚠️ 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

{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "title": "Name"
        },
        "icon": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Icon"
        },
        "provider": {
            "$ref": "#/components/schemas/ProviderType"
        },
        "provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                }
            ],
            "title": "Provider Config"
        },
        "provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Capabilities"
        },
        "fallback_provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "fallback_provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Config"
        },
        "fallback_provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Capabilities"
        },
        "tool_types": {
            "items": {
                "$ref": "#/components/schemas/GenerationTool"
            },
            "type": "array",
            "title": "Tool Types"
        },
        "recommended": {
            "type": "boolean",
            "title": "Recommended"
        },
        "beta": {
            "type": "boolean",
            "title": "Beta"
        },
        "max_output_width": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Width"
        },
        "max_output_height": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Height"
        },
        "max_size_pixels": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Size Pixels"
        }
    },
    "type": "object",
    "required": [
        "id",
        "name",
        "icon",
        "provider",
        "provider_config",
        "provider_capabilities",
        "tool_types",
        "recommended",
        "beta",
        "max_output_width",
        "max_output_height",
        "max_size_pixels"
    ],
    "title": "GenerativeModelsPublic",
    "description": "Schema for public generation model data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ 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

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/v1/generation-models/{id}

Read Generation Model

Description

Get generation model by ID. Public endpoint.

Input parameters

Parameter	In	Type	Default	Nullable	Description
id	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "f548d045-466e-42e7-af06-3edf1f9e1edc",
    "name": "string",
    "icon": null,
    "provider": "fal_standard",
    "provider_config": null,
    "provider_capabilities": null,
    "fallback_provider": null,
    "fallback_provider_config": null,
    "fallback_provider_capabilities": null,
    "tool_types": [
        "BASE_GENERATION"
    ],
    "recommended": true,
    "beta": true,
    "max_output_width": null,
    "max_output_height": null,
    "max_size_pixels": null
}

⚠️ 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

{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "title": "Name"
        },
        "icon": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Icon"
        },
        "provider": {
            "$ref": "#/components/schemas/ProviderType"
        },
        "provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                }
            ],
            "title": "Provider Config"
        },
        "provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Capabilities"
        },
        "fallback_provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "fallback_provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Config"
        },
        "fallback_provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Capabilities"
        },
        "tool_types": {
            "items": {
                "$ref": "#/components/schemas/GenerationTool"
            },
            "type": "array",
            "title": "Tool Types"
        },
        "recommended": {
            "type": "boolean",
            "title": "Recommended"
        },
        "beta": {
            "type": "boolean",
            "title": "Beta"
        },
        "max_output_width": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Width"
        },
        "max_output_height": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Height"
        },
        "max_size_pixels": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Size Pixels"
        }
    },
    "type": "object",
    "required": [
        "id",
        "name",
        "icon",
        "provider",
        "provider_config",
        "provider_capabilities",
        "tool_types",
        "recommended",
        "beta",
        "max_output_width",
        "max_output_height",
        "max_size_pixels"
    ],
    "title": "GenerativeModelsPublic",
    "description": "Schema for public generation model data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ 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

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

PUT /api/v1/generation-models/{id}

Update Generation Model

Description

Update generation model. Admin only.

Input parameters

Parameter	In	Type	Default	Nullable	Description
OAuth2PasswordBearer	header	string	N/A	No
id	path	string		No

Request body

application/json

{
    "name": null,
    "icon": null,
    "provider": null,
    "provider_config": null,
    "provider_capabilities": null,
    "fallback_provider": null,
    "fallback_provider_config": null,
    "fallback_provider_capabilities": null,
    "tool_types": null,
    "recommended": null,
    "beta": null,
    "max_output_width": null,
    "max_output_height": null,
    "max_size_pixels": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Name"
        },
        "icon": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Icon"
        },
        "provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Config"
        },
        "provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Capabilities"
        },
        "fallback_provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "fallback_provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Config"
        },
        "fallback_provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Capabilities"
        },
        "tool_types": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/GenerationTool"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Tool Types"
        },
        "recommended": {
            "anyOf": [
                {
                    "type": "boolean"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Recommended"
        },
        "beta": {
            "anyOf": [
                {
                    "type": "boolean"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Beta"
        },
        "max_output_width": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Width"
        },
        "max_output_height": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Height"
        },
        "max_size_pixels": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Size Pixels"
        }
    },
    "type": "object",
    "title": "GenerativeModelsUpdate",
    "description": "Schema for updating a generation model."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "6b74cd97-0018-4aa8-8776-190807d95ad7",
    "name": "string",
    "icon": null,
    "provider": "fal_standard",
    "provider_config": null,
    "provider_capabilities": null,
    "fallback_provider": null,
    "fallback_provider_config": null,
    "fallback_provider_capabilities": null,
    "tool_types": [
        "BASE_GENERATION"
    ],
    "recommended": true,
    "beta": true,
    "max_output_width": null,
    "max_output_height": null,
    "max_size_pixels": null
}

⚠️ 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

{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "title": "Name"
        },
        "icon": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Icon"
        },
        "provider": {
            "$ref": "#/components/schemas/ProviderType"
        },
        "provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                }
            ],
            "title": "Provider Config"
        },
        "provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Provider Capabilities"
        },
        "fallback_provider": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ProviderType"
                },
                {
                    "type": "null"
                }
            ]
        },
        "fallback_provider_config": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AiCoreProviderConfig"
                },
                {
                    "$ref": "#/components/schemas/NanoBananaUpscalerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalShootifyRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/FalStandardConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificConfig"
                },
                {
                    "$ref": "#/components/schemas/FreepikMagnificPrecisionConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateFaceFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateGarmentFixerConfig"
                },
                {
                    "$ref": "#/components/schemas/SartiqUltimateRefinerConfig"
                },
                {
                    "$ref": "#/components/schemas/VertexConfig"
                },
                {
                    "additionalProperties": true,
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Config"
        },
        "fallback_provider_capabilities": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/ProviderCapability"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Fallback Provider Capabilities"
        },
        "tool_types": {
            "items": {
                "$ref": "#/components/schemas/GenerationTool"
            },
            "type": "array",
            "title": "Tool Types"
        },
        "recommended": {
            "type": "boolean",
            "title": "Recommended"
        },
        "beta": {
            "type": "boolean",
            "title": "Beta"
        },
        "max_output_width": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Width"
        },
        "max_output_height": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Output Height"
        },
        "max_size_pixels": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Size Pixels"
        }
    },
    "type": "object",
    "required": [
        "id",
        "name",
        "icon",
        "provider",
        "provider_config",
        "provider_capabilities",
        "tool_types",
        "recommended",
        "beta",
        "max_output_width",
        "max_output_height",
        "max_size_pixels"
    ],
    "title": "GenerativeModelsPublic",
    "description": "Schema for public generation model data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ 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

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

DELETE /api/v1/generation-models/{id}

Delete Generation Model

Description

Delete generation model. Admin only.

Input parameters

Parameter	In	Type	Default	Nullable	Description
OAuth2PasswordBearer	header	string	N/A	No
id	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "message": "string"
}

⚠️ 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

{
    "properties": {
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "message"
    ],
    "title": "Message"
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ 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

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

Schemas

AiCoreProviderConfig

Name	Type	Description
additional_properties
ai_provider	string	AI provider to use: 'openai', 'anthropic', 'gemini', 'ollama'
max_tokens
model	string	Model name (e.g., 'gpt-4', 'claude-3-opus-20240229')
provider_type
temperature

FalShootifyRefinerConfig

Name	Type	Description
additional_properties
fal_app_id	string	FAL application ID for refinement
fal_request_id
provider_type

FalStandardConfig

Name	Type	Description
additional_properties
additional_static_params
fal_app_id	string	FAL application ID
fal_request_id
provider_type

FreepikMagnificConfig

Name	Type	Description
additional_properties
creativity		Creativity level (-10 to 10)
defaultPrompt
engine		Processing engine to use
fractality		Fractality level (-10 to 10)
hdr		HDR enhancement level (-10 to 10)
optimized_for		Optimization target for the upscaling
provider_type
resemblance		Resemblance to original (-10 to 10)

FreepikMagnificPrecisionConfig

Name	Type	Description
additional_properties
defaultPrompt
provider_type
sharpen		Sharpening level (0 to 100)
smart_grain		Smart grain level (0 to 100)
ultra_detail		Ultra detail level (0 to 100)

GenerationTool

Type: string

GenerativeModelsCreate

Name	Type	Description
beta	boolean
fallback_provider
fallback_provider_capabilities
fallback_provider_config
icon
max_output_height
max_output_width
max_size_pixels
name	string
provider	ProviderType
provider_capabilities
provider_config
recommended	boolean
tool_types	Array<GenerationTool>

GenerativeModelsListPublic

Name	Type	Description
count	integer
data	Array<GenerativeModelsPublic>

GenerativeModelsPublic

Name	Type	Description
beta	boolean
fallback_provider
fallback_provider_capabilities
fallback_provider_config
icon
id	string(uuid)
max_output_height
max_output_width
max_size_pixels
name	string
provider	ProviderType
provider_capabilities
provider_config
recommended	boolean
tool_types	Array<GenerationTool>

GenerativeModelsUpdate

Name	Type	Description
beta
fallback_provider
fallback_provider_capabilities
fallback_provider_config
icon
max_output_height
max_output_width
max_size_pixels
name
provider
provider_capabilities
provider_config
recommended
tool_types

HTTPValidationError

Name	Type	Description
detail	Array<ValidationError>

Message

Name	Type	Description
message	string

NanoBananaUpscalerConfig

Name	Type	Description
additional_properties
default_prompt
max_retries		Maximum API retries for failed consistency checks.
provider_type
ssim_threshold		SSIM threshold for structural consistency. Set to 0 to disable.

ProviderCapability

Type: string

ProviderType

Type: string

SartiqUltimateFaceFixerConfig

Name	Type	Description
additional_properties
dists_threshold		DISTS similarity threshold. 0 to disable (saves ~2GB RAM).
expand_percent		Face bbox expansion percentage (0.5 = 50%)
face_prompt
feather_px		Feather width in pixels for blending
lpips_threshold		LPIPS similarity threshold. 0 to disable (saves ~2GB RAM).
max_retries		Maximum API retries for failed consistency checks
provider_type
save_debug_images		Save intermediate images for debugging
ssim_threshold		SSIM threshold for structural consistency. 0 to disable.

SartiqUltimateGarmentFixerConfig

Name	Type	Description
additional_properties
bbox_expand_percent		How much to expand garment bounding box (0.05 = 5% larger).
dists_threshold		DISTS similarity threshold. 0 to disable (saves ~2GB RAM).
feather_px		Feather width in pixels for garment tile blending. 0 to disable.
lpips_threshold		LPIPS similarity threshold. 0 to disable (saves ~2GB RAM).
max_retries		Max retries per tile for failed consistency checks.
provider_type
save_debug_images		Save intermediate images for debugging.
split_threshold		Aspect ratio threshold for splitting elongated bboxes into 2 tiles.
ssim_threshold		SSIM threshold for structural consistency. 0 to disable.

SartiqUltimateRefinerConfig

Name	Type	Description
additional_properties
dists_threshold		DISTS similarity threshold. 0 to disable (saves ~2GB RAM).
face_expand_percent		How much to expand face bounding box (0.5 = 50% larger). V1 only, ignored in V2.
feather_px		Feather width in pixels for tile blending. 0 to disable.
lpips_threshold		LPIPS similarity threshold. 0 to disable (saves ~2GB RAM).
max_retries		Max retries per tile for failed consistency checks.
max_workers
num_tiles		Target number of tiles. Grid layout matches image aspect ratio.
provider_type
save_debug_tiles		Save intermediate tiles for debugging.
ssim_threshold		SSIM threshold for structural consistency. 0 to disable.
version		Pipeline version. '1' = face detection + Lab color correction + adaptive resolution. '2' = simplified with histogram color correction + always 4K + no face processing.

ValidationError

Name	Type	Description
ctx
input
loc	Array<>
msg	string
type	string

VertexConfig

Name	Type	Description
additional_properties
aspect_ratio
image_size		Output image size: '1K', '2K', or '4K'.
model
provider_type
system_instructions
temperature		Sampling temperature (0.0-2.0). Higher = more creative.
top_p		Top-p (nucleus) sampling threshold (0.0-1.0).

Security schemes

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2