{ "openapi": "3.0.1", "info": { "title": "Hugging Face Hub API", "description": "Access the Hugging Face Hub API to search & discover models, datasets & spaces.\nSearch Models: Find ML models by name, task or library\nSearch Datasets: Discover datasets for training & evaluation\nSearch Spaces: Explore ML applications\nGet Metadata: Retrieve detailed repo information", "version": "1.0", "x-build-id": "MaZyV4ygyxFD7BaZH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~hugging-face-hub/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-hugging-face-hub", "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-hub/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-hugging-face-hub", "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-hub/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-hugging-face-hub", "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": [ "search_models", "get_model", "search_datasets", "get_dataset", "search_spaces", "get_space", "list_model_files", "get_model_card", "trending_models", "trending_datasets" ], "type": "string", "description": "The Hub operation to perform", "default": "search_models" }, "apiToken": { "title": "Hugging Face API Token", "type": "string", "description": "Your Hugging Face API token (optional for public data)" }, "query": { "title": "Search Query", "type": "string", "description": "Search term for models, datasets, or spaces" }, "repoId": { "title": "Repository ID", "type": "string", "description": "Full repository ID (e.g., meta-llama/Llama-2-7b-hf)" }, "filter": { "title": "Filter", "type": "string", "description": "Filter by task, library, or other criteria" }, "taskType": { "title": "Task Type Filter", "enum": [ "", "text-generation", "text-classification", "token-classification", "question-answering", "summarization", "translation", "image-classification", "object-detection", "image-segmentation", "text-to-image", "image-to-text", "automatic-speech-recognition", "text-to-speech", "audio-classification", "feature-extraction", "sentence-similarity", "zero-shot-classification", "fill-mask" ], "type": "string", "description": "Filter by ML task type" }, "library": { "title": "Library Filter", "enum": [ "", "transformers", "pytorch", "tensorflow", "jax", "diffusers", "sentence-transformers", "onnx", "safetensors", "gguf" ], "type": "string", "description": "Filter by framework/library" }, "sort": { "title": "Sort By", "enum": [ "downloads", "likes", "trending", "created", "modified" ], "type": "string", "description": "Sort results by", "default": "downloads" }, "direction": { "title": "Sort Direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Sort direction", "default": "desc" }, "limit": { "title": "Result Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to return", "default": 20 }, "includeCardData": { "title": "Include Card Data", "type": "boolean", "description": "Include model/dataset card metadata", "default": false }, "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 } } } } } } } } } }