{ "openapi": "3.0.1", "info": { "title": "AZLyrics Scraper & Translator", "description": "Scrape song lyrics from AZLyrics in bulk. Search by artist, song title, or keywords. Extract full artist catalogs with metadata. Translate lyrics to any language with AI. The cheapest per-song lyrics scraper on Apify — built for NLP researchers, dataset builders, and music data projects.", "version": "0.0", "x-build-id": "mZNJUCrRQBDnnp1Ch" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/marielise.dev~azlyrics-scraper-translator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-marielise.dev-azlyrics-scraper-translator", "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/marielise.dev~azlyrics-scraper-translator/runs": { "post": { "operationId": "runs-sync-marielise.dev-azlyrics-scraper-translator", "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/marielise.dev~azlyrics-scraper-translator/run-sync": { "post": { "operationId": "run-sync-marielise.dev-azlyrics-scraper-translator", "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", "properties": { "artistName": { "title": "Artist Name", "type": "string", "description": "Artist or band name. Used alone to scrape all songs, or with 'Song Title' to find specific lyrics. Examples: 'Pomme', 'Radiohead', 'Kendrick Lamar'." }, "songTitle": { "title": "Song Title", "type": "string", "description": "Song title to search for. Requires 'Artist Name' to be set. Examples: 'Soleil Soleil', 'Creep'." }, "searchQuery": { "title": "Search Query (free text)", "type": "string", "description": "Free-text search. Tries to guess artist and song from the query. For best results, use 'Artist Name' + 'Song Title' fields instead. Examples: 'Pomme Soleil Soleil', 'Radiohead Creep'." }, "startUrls": { "title": "Direct AZLyrics URLs", "type": "array", "description": "Provide direct AZLyrics URLs to scrape. Use this instead of artist names for specific songs or artist pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Maximum Results", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of songs to scrape. Set to 0 for no limit.", "default": 50 }, "translateTo": { "title": "Translate Lyrics To", "type": "string", "description": "Translate lyrics to this language using AI. Use the language name, e.g. 'English', 'Spanish', 'French'. Leave empty to skip. Works out of the box at $0.008/song, or provide your own API key below for $0.002/song.", "default": "English" }, "translateApiKey": { "title": "API Key (BYOK)", "type": "string", "description": "Your OpenAI-compatible API key. If provided, you pay your LLM provider directly and translation is charged at the lower BYOK rate. If omitted, the built-in service is used." }, "translateModel": { "title": "Model", "type": "string", "description": "The chat completions model to use. Only relevant with your own API key.", "default": "gpt-4o-mini" }, "translateBaseUrl": { "title": "API Base URL", "type": "string", "description": "Base URL for the OpenAI-compatible API. Only change this for non-OpenAI providers, e.g. 'https://generativelanguage.googleapis.com/v1beta/openai/' for Google Gemini." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended for AZLyrics." } } }, "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 } } } } } } } } } }