POST
/
apiKey
/
v2
/
execute
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v2/execute \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "testTargetId": "2e2bb27b-a19c-47ce-a9b6-cd1bd31622dc",
  "url": "https://example.com",
  "context": {
    "source": "github",
    "issueNumber": 123,
    "ref": "refs/heads/main",
    "sha": "abc123def456",
    "repo": "my-repo",
    "owner": "repo-owner",
    "triggeredBy": {
      "type": "USER",
      "userId": "user123"
    },
    "nodeId": "node-123"
  },
  "environmentName": "default",
  "variablesToOverwrite": {
    "SPACE_ID": [
      "64ee32b4-7365-47a6-b5b0-2903b6ad849d"
    ]
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}'
{
  "testReportUrl": "https://example.com",
  "testReport": {
    "id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
    "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
    "createdAt": "2024-09-06T13:01:51.686Z",
    "updatedAt": "2024-09-06T13:05:23.412Z",
    "executionUrl": "https://en.wikipedia.org/",
    "status": "FAILED",
    "context": {
      "source": "github",
      "issueNumber": 123,
      "ref": "refs/heads/main",
      "sha": "abc123def456",
      "repo": "my-repo",
      "owner": "repo-owner",
      "triggeredBy": {
        "type": "USER",
        "userId": "user123"
      },
      "nodeId": "node-123"
    },
    "testResults": [
      {
        "id": "7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
        "testCaseId": "9876fedc-ba98-7654-3210-fedcba987654",
        "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
        "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
        "name": "User can search for information",
        "createdAt": "2024-09-06T13:01:51.686Z",
        "updatedAt": "2024-09-06T13:03:12.345Z",
        "status": "PASSED",
        "errorMessage": null,
        "traceUrl": "https://storage.googleapis.com/automagically-traces/7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p-trace.zip"
      },
      {
        "id": "2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p",
        "testCaseId": "5432fedc-ba98-7654-3210-fedcba543210",
        "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
        "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
        "name": "User can navigate to article",
        "createdAt": "2024-09-06T13:01:51.686Z",
        "updatedAt": "2024-09-06T13:04:45.678Z",
        "status": "FAILED",
        "errorMessage": "TimeoutError: locator.click: Timeout 30000ms exceeded.",
        "traceUrl": "https://storage.googleapis.com/automagically-traces/2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p-trace.zip"
      },
      {
        "id": "3a4b5c6d-7e8f-9g0h-1i2j-3k4l5m6n7o8p",
        "testCaseId": "1234abcd-ef56-7890-abcd-ef1234567890",
        "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
        "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
        "name": "User can create an account",
        "createdAt": "2024-09-06T13:01:51.686Z",
        "updatedAt": "2024-09-06T13:05:23.412Z",
        "status": "WAITING",
        "errorMessage": null,
        "traceUrl": null
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
testTargetId
string
required

Unique identifier for the testTarget.

Example:

"2e2bb27b-a19c-47ce-a9b6-cd1bd31622dc"

​
url
string
required

The URL of the test target for this run.

Example:

"https://example.com"

​
context
object
required
​
environmentName
string
default:default

the environment name you want to run your test against

​
variablesToOverwrite
object

The variables to overwrite exclusively for this test run.

Example:
{
  "SPACE_ID": ["64ee32b4-7365-47a6-b5b0-2903b6ad849d"]
}
​
tags
string[]
Example:
["tag1", "tag2"]

Response

200
application/json
Test executed successfully
​
testReportUrl
string

The URL the test target was executed.

Example:

"https://example.com"

​
testReport
object

The test report from the run.

Example:
{
  "id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
  "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
  "createdAt": "2024-09-06T13:01:51.686Z",
  "updatedAt": "2024-09-06T13:05:23.412Z",
  "executionUrl": "https://en.wikipedia.org/",
  "status": "FAILED",
  "context": {
    "source": "github",
    "issueNumber": 123,
    "ref": "refs/heads/main",
    "sha": "abc123def456",
    "repo": "my-repo",
    "owner": "repo-owner",
    "triggeredBy": { "type": "USER", "userId": "user123" },
    "nodeId": "node-123"
  },
  "testResults": [
    {
      "id": "7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
      "testCaseId": "9876fedc-ba98-7654-3210-fedcba987654",
      "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
      "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
      "name": "User can search for information",
      "createdAt": "2024-09-06T13:01:51.686Z",
      "updatedAt": "2024-09-06T13:03:12.345Z",
      "status": "PASSED",
      "errorMessage": null,
      "traceUrl": "https://storage.googleapis.com/automagically-traces/7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p-trace.zip"
    },
    {
      "id": "2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p",
      "testCaseId": "5432fedc-ba98-7654-3210-fedcba543210",
      "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
      "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
      "name": "User can navigate to article",
      "createdAt": "2024-09-06T13:01:51.686Z",
      "updatedAt": "2024-09-06T13:04:45.678Z",
      "status": "FAILED",
      "errorMessage": "TimeoutError: locator.click: Timeout 30000ms exceeded.",
      "traceUrl": "https://storage.googleapis.com/automagically-traces/2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p-trace.zip"
    },
    {
      "id": "3a4b5c6d-7e8f-9g0h-1i2j-3k4l5m6n7o8p",
      "testCaseId": "1234abcd-ef56-7890-abcd-ef1234567890",
      "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
      "testReportId": "826c15af-644b-4b28-89b4-f50ff34e46b7",
      "name": "User can create an account",
      "createdAt": "2024-09-06T13:01:51.686Z",
      "updatedAt": "2024-09-06T13:05:23.412Z",
      "status": "WAITING",
      "errorMessage": null,
      "traceUrl": null
    }
  ]
}