{ "openapi": "3.0.1", "info": { "title": "Hugging Face Image AI", "description": "Image processing w/Hugging Face models\nText-to-Image: Stable Diffusion, SDXL, DALL-E generation\nImage-to-Image: Transform images\nInpainting: Edit parts of images\nClassification: Identify objects\nObject Detection: Locate label objects\nSegmentation: Pixel analysis\nCaptioning: Generate descriptions", "version": "1.0", "x-build-id": "fu5ajGZZyzQYbBlAG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~hugging-face-image-ai/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-hugging-face-image-ai", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~hugging-face-image-ai/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-hugging-face-image-ai", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~hugging-face-image-ai/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-hugging-face-image-ai", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "text_to_image", "image_to_image", "inpainting", "image_to_text", "image_classification", "object_detection", "image_segmentation", "zero_shot_image_classification", "depth_estimation", "image_upscaling" ], "type": "string", "description": "The image operation to perform", "default": "text_to_image" }, "apiToken": { "title": "Hugging Face API Token", "type": "string", "description": "Your Hugging Face API token" }, "model": { "title": "Model ID", "type": "string", "description": "Hugging Face model ID (leave blank for default)" }, "prompt": { "title": "Prompt", "type": "string", "description": "Text prompt for image generation" }, "negativePrompt": { "title": "Negative Prompt", "type": "string", "description": "What to avoid in generated images" }, "imageUrl": { "title": "Image URL", "type": "string", "description": "URL of input image for image-based tasks" }, "maskUrl": { "title": "Mask URL", "type": "string", "description": "URL of mask image for inpainting" }, "candidateLabels": { "title": "Candidate Labels", "type": "string", "description": "Comma-separated labels for zero-shot classification" }, "width": { "title": "Image Width", "type": "integer", "description": "Output image width", "default": 1024 }, "height": { "title": "Image Height", "type": "integer", "description": "Output image height", "default": 1024 }, "guidanceScale": { "title": "Guidance Scale (CFG)", "type": "number", "description": "How closely to follow the prompt (1-20)", "default": 7.5 }, "numInferenceSteps": { "title": "Inference Steps", "minimum": 1, "maximum": 150, "type": "integer", "description": "Number of diffusion steps (more = better quality, slower)", "default": 50 }, "strength": { "title": "Strength", "type": "number", "description": "How much to transform the input image (0-1)", "default": 0.8 }, "seed": { "title": "Seed", "type": "integer", "description": "Random seed for reproducible results" }, "scheduler": { "title": "Scheduler", "enum": [ "default", "DDIM", "K_EULER", "K_EULER_ANCESTRAL", "PNDM", "DPM_SOLVER" ], "type": "string", "description": "Diffusion scheduler", "default": "default" }, "waitForModel": { "title": "Wait for Model", "type": "boolean", "description": "Wait for model to load if not ready", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data (no API calls)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }