{ "openapi": "3.0.1", "info": { "title": "Ashby Jobs API", "description": "Extract normalized public jobs, teams, remote status, compensation, and changes from Ashby boards.", "version": "0.1", "x-build-id": "L3mGDETxOEGN0jvaa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/istenotools~ashby-jobs-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-istenotools-ashby-jobs-api", "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/istenotools~ashby-jobs-api/runs": { "post": { "operationId": "runs-sync-istenotools-ashby-jobs-api", "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/istenotools~ashby-jobs-api/run-sync": { "post": { "operationId": "run-sync-istenotools-ashby-jobs-api", "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": { "startUrls": { "title": "Career pages or job boards", "type": "array", "description": "Add one or more public Ashby job-board URLs. HTTPS only.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sources": { "title": "Structured sources", "type": "array", "description": "Optional advanced source objects with url, provider, companyName, and label.", "default": [] }, "maxItems": { "title": "Maximum paid results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap across all sources. One default-dataset item is one chargeable result.", "default": 1000 }, "mode": { "title": "Output mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "Snapshot emits current jobs. Changes emits only added, updated, and removed jobs versus saved state.", "default": "snapshot" }, "stateStoreName": { "title": "Change-state store name", "pattern": "^[a-zA-Z0-9_-]{3,63}$", "type": "string", "description": "Optional stable key-value store name. If omitted, one is derived from sources and filters." }, "titleKeywords": { "title": "Include title keywords", "type": "array", "description": "Emit jobs whose title contains at least one term. Leave empty for all titles.", "default": [], "items": { "type": "string" } }, "excludeTitleKeywords": { "title": "Exclude title keywords", "type": "array", "description": "Drop jobs whose title contains any term.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Case-insensitive location substrings. Leave empty for every location.", "default": [], "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Case-insensitive department substrings. Leave empty for every department.", "default": [], "items": { "type": "string" } }, "remoteOnly": { "title": "Remote or hybrid only", "type": "boolean", "description": "Emit only records identified as remote or hybrid.", "default": false }, "postedAfter": { "title": "Posted on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional ISO date in YYYY-MM-DD format." }, "includeDescription": { "title": "Include job descriptions", "type": "boolean", "description": "Fetch and normalize descriptions when the source exposes them.", "default": true }, "includeCompensation": { "title": "Include compensation", "type": "boolean", "description": "Include public salary or compensation fields when the source exposes them.", "default": true }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Bounded request concurrency across sources and detail pages.", "default": 5 }, "requestTimeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time allowed for each source request.", "default": 30 }, "retryCount": { "title": "Retry count", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries timeout, rate-limit, and server errors with backoff.", "default": 2 }, "failOnSourceError": { "title": "Fail if any source fails", "type": "boolean", "description": "When disabled, healthy sources still return results and failed sources cannot create false removals.", "default": false } } }, "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 } } } } } } } } } }