{ "openapi": "3.0.1", "info": { "title": "Hugging Face Master", "description": "Unified Apify actor for Hugging Face Inference API access 200K+ AI models for text image audio processing\nText Generation LLMs Llama\nSummarization Condense documents\nTranslation 100+ languages\nSentiment Analysis\nImage Generation Stable Diffusion\nSpeech transcription\nSemantic search\nQA classification", "version": "1.0", "x-build-id": "1URjFGDW3BdxZ3zD2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~hugging-face-master/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-hugging-face-master", "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-master/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-hugging-face-master", "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-master/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-hugging-face-master", "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_generation", "summarization", "translation", "sentiment_analysis", "text_classification", "question_answering", "fill_mask", "embeddings", "image_generation", "image_to_text", "image_classification", "object_detection", "speech_to_text", "text_to_speech", "audio_classification", "zero_shot_classification" ], "type": "string", "description": "The operation to perform", "default": "text_generation" }, "apiToken": { "title": "Hugging Face API Token", "type": "string", "description": "Your Hugging Face API token (from hf.co/settings/tokens)" }, "model": { "title": "Model ID", "type": "string", "description": "Hugging Face model ID (e.g., meta-llama/Llama-2-7b-chat-hf, stabilityai/stable-diffusion-xl-base-1.0)" }, "text": { "title": "Input Text", "type": "string", "description": "Text input for text-based tasks" }, "prompt": { "title": "Prompt", "type": "string", "description": "Prompt for generation tasks" }, "context": { "title": "Context", "type": "string", "description": "Context for question answering" }, "question": { "title": "Question", "type": "string", "description": "Question for Q&A tasks" }, "sourceLanguage": { "title": "Source Language", "type": "string", "description": "Source language for translation" }, "targetLanguage": { "title": "Target Language", "type": "string", "description": "Target language for translation" }, "candidateLabels": { "title": "Candidate Labels", "type": "string", "description": "Comma-separated labels for zero-shot classification" }, "imageUrl": { "title": "Image URL", "type": "string", "description": "URL of image for image-based tasks" }, "audioUrl": { "title": "Audio URL", "type": "string", "description": "URL of audio file for audio-based tasks" }, "negativePrompt": { "title": "Negative Prompt", "type": "string", "description": "Negative prompt for image generation" }, "maxTokens": { "title": "Max Tokens", "minimum": 1, "maximum": 4096, "type": "integer", "description": "Maximum tokens to generate", "default": 256 }, "temperature": { "title": "Temperature", "type": "number", "description": "Sampling temperature (0.0-2.0)", "default": 0.7 }, "topP": { "title": "Top P", "type": "number", "description": "Nucleus sampling parameter", "default": 0.9 }, "numImages": { "title": "Number of Images", "minimum": 1, "maximum": 4, "type": "integer", "description": "Number of images to generate", "default": 1 }, "width": { "title": "Image Width", "type": "integer", "description": "Image width in pixels", "default": 1024 }, "height": { "title": "Image Height", "type": "integer", "description": "Image height in pixels", "default": 1024 }, "guidanceScale": { "title": "Guidance Scale", "type": "number", "description": "CFG scale for image generation", "default": 7.5 }, "numInferenceSteps": { "title": "Inference Steps", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of diffusion steps", "default": 50 }, "waitForModel": { "title": "Wait for Model", "type": "boolean", "description": "Wait for model to load if not ready", "default": true }, "useCache": { "title": "Use Cache", "type": "boolean", "description": "Use cached results if available", "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 } } } } } } } } } }