Pricing
from $14.00 / 1,000 specs
Run your JavaScript-based automation and testing scripts built with Cypress framework on the cloud. Automate and schedule your runs in Apify Console and connect them to other platforms and services to make your workflow even more efficient.
0.0 (0)
Pricing
from $14.00 / 1,000 specs
0
1
1
Last modified
3 days ago
You can access the Cypress Cloud Runner programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "moNWIGiaEdUfcTOTv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/serhatcakmaktepe~cypress-cloud-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-serhatcakmaktepe-cypress-cloud-runner", "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/serhatcakmaktepe~cypress-cloud-runner/runs": { "post": { "operationId": "runs-sync-serhatcakmaktepe-cypress-cloud-runner", "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/serhatcakmaktepe~cypress-cloud-runner/run-sync": { "post": { "operationId": "run-sync-serhatcakmaktepe-cypress-cloud-runner", "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": [ "gitUrl" ], "properties": { "gitUrl": { "title": "Repository URL", "type": "string", "description": "Git repository URL containing your Cypress tests (HTTPS or SSH)" }, "branch": { "title": "Branch/Tag/Commit", "type": "string", "description": "Git branch, tag, or commit to checkout", "default": "main" }, "projectPath": { "title": "Project Path", "type": "string", "description": "Path to Cypress project within repository (optional, for monorepos)" }, "installCommand": { "title": "Install Command", "type": "string", "description": "Command to install dependencies", "default": "npm ci" }, "testCommand": { "title": "Test Command", "type": "string", "description": "Command to run Cypress tests", "default": "npx cypress run" }, "browser": { "title": "Browser", "enum": [ "chrome", "firefox", "electron", "edge" ], "type": "string", "description": "Browser to run tests in", "default": "electron" }, "spec": { "title": "Spec Pattern", "type": "string", "description": "Specific spec file(s) to run (optional)" }, "env": { "title": "Environment Variables", "type": "object", "description": "Environment variables to pass to Cypress", "default": {} }, "config": { "title": "Cypress Config", "type": "object", "description": "Cypress configuration overrides", "default": {} }, "saveArtifacts": { "title": "Save Test Artifacts", "type": "boolean", "description": "Save videos and screenshots to Key-Value store", "default": true }, "buildCommand": { "title": "Build Command", "type": "string", "description": "Optional command to build the application before starting the server (e.g. 'npm run build')" }, "startCommand": { "title": "Start Command", "type": "string", "description": "Optional command to start the application server before running Cypress (e.g. 'npm start' or 'npx http-server dist -p 8080')" }, "startReadyUrl": { "title": "Ready URL(s)", "type": "string", "description": "URL(s) to wait for after starting the server (comma-separated). If omitted, uses config.baseUrl." }, "startReadyTimeoutSecs": { "title": "Ready Timeout (secs)", "type": "integer", "description": "Maximum time to wait for server readiness before continuing", "default": 60 }, "gracefulShutdownSecs": { "title": "Shutdown Grace (secs)", "type": "integer", "description": "How long to wait for server to stop before force killing", "default": 10 }, "killSignal": { "title": "Kill Signal", "type": "string", "description": "Signal to use when stopping the started server", "default": "SIGTERM" }, "strictBaseUrlCheck": { "title": "Fail on Bad Base URL", "type": "boolean", "description": "If true, the actor fails fast when baseUrl returns a non-2xx/3xx response before running tests", "default": false }, "splitSpecs": { "title": "Run each spec separately", "type": "boolean", "description": "Runs Cypress once per spec file and pushes one dataset item per file. Ensures precise pay-per-spec billing and clearer results at the cost of slightly longer total time.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST test results to (optional)" } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Cypress Cloud Runner from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: