{ "openapi": "3.0.1", "info": { "title": "Username Generator & Checker", "description": "Generate brand-safe, tone-specific usernames with an LLM pipeline, then verify availability across GitHub, X, Twitch, and YouTube in one run.", "version": "0.1", "x-build-id": "Isfprz4JEWVu6fjRo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/protocol~username-generator-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-protocol-username-generator-checker", "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/protocol~username-generator-checker/runs": { "post": { "operationId": "runs-sync-protocol-username-generator-checker", "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/protocol~username-generator-checker/run-sync": { "post": { "operationId": "run-sync-protocol-username-generator-checker", "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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "minItems": 1, "type": "array", "description": "Required. Seed words or themes the usernames should be built around (e.g. [\"vault\", \"alpha\"]). Provide at least one. Each keyword is woven into generated candidates where natural. Do not include personal data you don't want sent to an LLM provider.", "items": { "type": "string" } }, "brandName": { "title": "Brand name", "type": "string", "description": "Optional. An existing brand name whose fragments should be incorporated into candidates where natural (e.g. \"BrandCraft\" may yield \"brandcrafthq\"). Leave empty if naming from scratch." }, "personalName": { "title": "Personal name", "type": "string", "description": "Optional. A personal name to incorporate for individual/creator handles (e.g. \"Ray\" may yield \"raybuilds\"). Note: name-derived outputs persist in the run's dataset and exports." }, "niche": { "title": "Industry / niche", "type": "string", "description": "Optional. Industry, niche, or category the username is for (e.g. \"fintech\", \"indie gaming\", \"food blogging\"). Drives industry naming conventions in generation — fintech favors short/trust-evoking names, gaming favors thematic/clan-style, creator brands favor memorable/personal." }, "tone": { "title": "Tone / style", "enum": [ "Professional", "Minimal", "Gamer", "Creative" ], "type": "string", "description": "Optional. Naming tone applied to all candidates. Must be exactly one of: \"Professional\" (corporate, trust-evoking), \"Minimal\" (short, clean, lowercase feel), \"Gamer\" (thematic, edgy, gaming-culture style), \"Creative\" (playful, unexpected wordplay). Defaults to \"Professional\".", "default": "Professional" }, "platforms": { "title": "Target platforms", "uniqueItems": true, "type": "array", "description": "Optional. Platforms to verify availability on. Allowed values: \"github\", \"x\", \"twitch\", \"youtube\", \"threads\", \"instagram\", \"tiktok\" (lowercase, exactly as listed — e.g. use \"x\", not \"twitter\"). Defaults to [\"github\"], the most reliable check. \"x\" is optional and not selected by default — it frequently returns status \"unknown\" due to login walls, so select it deliberately. \"tiktok\" is also optional and not selected by default — TikTok's anti-enumeration design means it can confirm a handle is taken but cannot confirm one is available, so expect a high \"unknown\" rate for genuinely free names; this is a platform limitation, not a bug. Each candidate is checked on every selected platform (one output row per candidate-platform pair).", "items": { "type": "string", "enum": [ "github", "x", "twitch", "youtube", "threads", "instagram", "tiktok" ], "enumTitles": [ "GitHub", "X (Twitter)", "Twitch", "YouTube", "Threads", "Instagram", "TikTok" ] }, "default": [ "github" ] }, "maxLength": { "title": "Maximum username length", "minimum": 1, "maximum": 30, "type": "integer", "description": "Optional. Maximum character length for generated usernames. Hard cap 30 (YouTube/Instagram/Threads' limit — the longest supported platforms). Defaults to 20, a safe cross-platform value; note X allows only 15 characters and TikTok only 24, so set the limit accordingly when targeting those platforms. Values above 30 are rejected.", "default": 20 }, "bannedWords": { "title": "Banned words", "type": "array", "description": "Optional. Words that must never appear in generated usernames (e.g. competitor names, sensitive terms). Matching is applied after normalization and de-leeting, so \"d3vil\" is caught by banning \"devil\". Defaults to [] (no extra filtering beyond the built-in profanity list).", "items": { "type": "string" }, "default": [] }, "count": { "title": "Number of usernames", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional. How many username candidates to generate. Hard cap 20 per run — this bounds LLM cost and keeps availability checks within the run-time budget; a higher count is rejected before generation. Defaults to 10.", "default": 10 }, "inputMode": { "title": "Run mode", "enum": [ "full", "generate_only" ], "type": "string", "description": "Optional. \"full\" (default) generates candidates AND verifies availability on the selected platforms — the complete, billable pipeline. \"generate_only\" generates and filters candidates but skips all availability checks: rows come back with status \"unverified\", it is much cheaper and non-billable, ideal for fast iterative brainstorming before committing to a full verification run. No other value is accepted in V1 (\"validate\" is planned but not yet available).", "default": "full" } } }, "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 } } } } } } } } } }