{ "openapi": "3.0.1", "info": { "title": "Hugging Face Text", "description": "Comprehensive text processing w/Hugging Face models generation, NLP & embeddings.\nText Generations\nChat Completion\nSummarization Condense documents\nTranslation\nSentiment Analysis Classify sentiment\nNER Named entity recognition\nQ&A Answer context\nEmbeddings Semantic search\nZero-Shot without training", "version": "1.0", "x-build-id": "nb3RqVdTUotrOacvV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~hugging-face-text/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-hugging-face-text", "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-text/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-hugging-face-text", "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-text/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-hugging-face-text", "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", "chat_completion", "summarization", "translation", "sentiment_analysis", "ner", "question_answering", "fill_mask", "embeddings", "zero_shot_classification", "text_similarity", "paraphrase" ], "type": "string", "description": "The text operation to perform", "default": "text_generation" }, "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)" }, "text": { "title": "Input Text", "type": "string", "description": "Text input for processing" }, "texts": { "title": "Multiple Texts (JSON Array)", "type": "string", "description": "JSON array of texts for batch processing" }, "prompt": { "title": "Prompt", "type": "string", "description": "Prompt for generation tasks" }, "systemPrompt": { "title": "System Prompt", "type": "string", "description": "System prompt for chat completion" }, "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 code (e.g., en, es, fr)" }, "targetLanguage": { "title": "Target Language", "type": "string", "description": "Target language code" }, "candidateLabels": { "title": "Candidate Labels", "type": "string", "description": "Comma-separated labels for zero-shot classification" }, "compareText": { "title": "Compare Text", "type": "string", "description": "Second text for similarity comparison" }, "maxTokens": { "title": "Max Tokens", "minimum": 1, "maximum": 4096, "type": "integer", "description": "Maximum tokens to generate", "default": 256 }, "minTokens": { "title": "Min Tokens", "minimum": 1, "type": "integer", "description": "Minimum tokens to generate (for summarization)", "default": 30 }, "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 }, "topK": { "title": "Top K", "type": "integer", "description": "Top-k sampling parameter", "default": 50 }, "repetitionPenalty": { "title": "Repetition Penalty", "type": "number", "description": "Penalty for repetition (1.0 = no penalty)", "default": 1 }, "doSample": { "title": "Do Sample", "type": "boolean", "description": "Use sampling instead of greedy decoding", "default": true }, "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 } } } } } } } } } }