Execute tests of the given test target

curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v3/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"
  ],
  "breakpoint": "DESKTOP",
  "browser": "CHROMIUM"
}
'

{
  "testReportUrl": "https://app.octomind.dev/testreports/826c15af-644b-4b28-89b4-f50ff34e46b7",
  "testReport": {
    "id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
    "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
    "createdAt": "2024-09-06T13:01:51.686Z",
    "updatedAt": "2024-09-06T13:01:51.686Z",
    "executionUrl": "https://en.wikipedia.org/",
    "status": "WAITING",
    "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"
    },
    "breakpoint": "DESKTOP",
    "browser": "CHROMIUM",
    "testResults": [
      {
        "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
          }
        ]
      }
    ]
  }
}

POST

apiKey

execute

Execute tests of the given test target

curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v3/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"
  ],
  "breakpoint": "DESKTOP",
  "browser": "CHROMIUM"
}
'

{
  "testReportUrl": "https://app.octomind.dev/testreports/826c15af-644b-4b28-89b4-f50ff34e46b7",
  "testReport": {
    "id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
    "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
    "createdAt": "2024-09-06T13:01:51.686Z",
    "updatedAt": "2024-09-06T13:01:51.686Z",
    "executionUrl": "https://en.wikipedia.org/",
    "status": "WAITING",
    "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"
    },
    "breakpoint": "DESKTOP",
    "browser": "CHROMIUM",
    "testResults": [
      {
        "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<uuid>

required

Unique identifier for the testTarget.

Example:

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

url

string<uri>

required

The URL of the test target for this run.

Example:

"https://example.com"

context

object

required

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6

Show child attributes

context.source

enum<string>

Available options:

github

Example:

"github"

context.issueNumber

integer | null

Example:

123

context.ref

string | null

Example:

"refs/heads/main"

context.sha

string | null

Example:

"abc123def456"

context.repo

string

Example:

"my-repo"

context.owner

string

Example:

"repo-owner"

context.triggeredBy

object

Show child attributes

context.triggeredBy.type

enum<string>

Available options:

USER

Example:

"USER"

context.triggeredBy.userId

string

Example:

"user123"

context.nodeId

string | null

Example:

"node-123"

environmentName

string<environment name>

default:default

the environment name you want to run your test against

variablesToOverwrite

object

The variables to overwrite exclusively for this test run.

Show child attributes

variablesToOverwrite.{key}

string[]

Example:

{
  "SPACE_ID": ["64ee32b4-7365-47a6-b5b0-2903b6ad849d"]
}

Response

Test executed successfully

testReportUrl

string<uri>

The URL where the test report can be accessed.

Example:

"https://app.octomind.dev/testreports/826c15af-644b-4b28-89b4-f50ff34e46b7"

testReport

object

Show child attributes

testReport.id

string<uuid>

Unique identifier for the test report.

Example:

"826c15af-644b-4b28-89b4-f50ff34e46b7"

testReport.testTargetId

string<uuid>

The unique identifier of the test target.

Example:

"3435918b-3d29-4ebd-8c68-9a540532f45a"

testReport.createdAt

string<date-time>

The timestamp when the test report was created.

Example:

"2024-09-06T13:01:51.686Z"

testReport.updatedAt

string<date-time>

The timestamp when the test report was last updated.

Example:

"2024-09-06T13:01:51.686Z"

testReport.executionUrl

string<uri>

The URL where the test execution was performed.

Example:

"https://en.wikipedia.org/"

testReport.status

enum<string>

The status of the test report, will be WAITING as long as any result is running, FAILED if the report is done but has any failed result and PASSED if all test results are done and successful

Available options:

WAITING,

PASSED,

FAILED

testReport.context

object

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6

Show child attributes

testReport.context.source

enum<string>

Available options:

github

Example:

"github"

testReport.context.issueNumber

integer | null

Example:

123

testReport.context.ref

string | null

Example:

"refs/heads/main"

testReport.context.sha

string | null

Example:

"abc123def456"

testReport.context.repo

string

Example:

"my-repo"

testReport.context.owner

string

Example:

"repo-owner"

testReport.context.triggeredBy

object

Show child attributes

testReport.context.triggeredBy.type

enum<string>

Available options:

USER

Example:

"USER"

testReport.context.triggeredBy.userId

string

Example:

"user123"

testReport.context.nodeId

string | null

Example:

"node-123"

testReport.breakpoint

enum<string>

default:DESKTOP

The breakpoint to run the test cases against.

Available options:

MOBILE,

TABLET,

DESKTOP

Example:

"DESKTOP"

testReport.browser

enum<string>

default:CHROMIUM

The browser to run the test cases against.

Available options:

CHROMIUM,

FIREFOX,

SAFARI

Example:

"CHROMIUM"

testReport.testResults

object[]

Show child attributes

testReport.testResults.id

string<uuid>

Unique identifier for the test result.

Example:

"826c15af-644b-4b28-89b4-f50ff34e46b7"

testReport.testResults.testTargetId

string<uuid>

Unique identifier of the test report this result belongs to.

Example:

"3435918b-3d29-4ebd-8c68-9a540532f45a"

testReport.testResults.testCaseId

string<uuid>

Unique identifier of the test case this result belongs to.

Example:

"5b844cf1-d597-4048-9e74-7c0f9ce3e2ee"

testReport.testResults.createdAt

string<date-time>

The timestamp when the test result was created.

Example:

"2024-09-06T13:01:51.686Z"

testReport.testResults.updatedAt

string<date-time>

The timestamp when the test result was last updated.

Example:

"2024-09-06T13:01:51.686Z"

testReport.testResults.status

enum<string>

The status of the specific test result, will be WAITING as long as the result is running, FAILED if the execution failed, PASSED if it succeeded, and ERROR if an internal error occurred.

Available options:

WAITING,

PASSED,

FAILED,

ERROR

testReport.testResults.errorMessage

string | null

The error that has occurred during execution - only set if the status is FAILED or ERROR.

Example:

"TimeoutError: locator.click: Timeout 30000ms exceeded."

testReport.testResults.traceUrl

string | null

Link to the playwright trace of the test execution - only set once the test result is finished (PASSED or FAILED).

Example:

"https://storage.googleapis.com/automagically-traces/826c15af-644b-4b28-89b4-f50ff34e46b7-trace.zip"

testReport.testResults.breakpoint

enum<string>

default:DESKTOP

The breakpoint to run the test cases against.

Available options:

MOBILE,

TABLET,

DESKTOP

Example:

"DESKTOP"

testReport.testResults.browser

enum<string>

default:CHROMIUM

The browser to run the test cases against.

Available options:

CHROMIUM,

FIREFOX,

SAFARI

Example:

"CHROMIUM"

Retrieve test target configuration Create a batch generation

⌘I

Test targets

Execute

Discoveries

Environments

Reports

Notifications

Private locations

Test Cases

Execute tests of the given test target

Authorizations

Body

Response