Skip to main content
POST
/
apiKey
/
v3
/
test-plan
/
explore
Explore a test plan
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v3/test-plan/explore \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://preview-123.example.com",
  "testTargetId": "2e2bb27b-a19c-47ce-a9b6-cd1bd31622dc",
  "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": "staging"
}
'
{
  "message": "<string>",
  "testPlanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discoveries": [
    {
      "testCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discoveryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "testCaseName": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string<uri>
required

The URL where the PR deployment is running

Example:

"https://preview-123.example.com"

testTargetId
string<uuid>
required

Unique identifier for the test target

Example:

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

context
object
required
environmentName
string

The environment name to use for exploration

Example:

"staging"

Response

Test plan exploration completed successfully

message
string

Status message

testPlanId
string<uuid>

The ID of the test plan being explored

discoveries
object[]