POST
/
apiKey
/
v2
/
test-targets
/
{testTargetId}
/
discoveries
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v2/test-targets/{testTargetId}/discoveries \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Login Flow Validation",
  "prompt": "Verify that users can successfully log in with valid credentials and see their dashboard.",
  "entryPointUrlPath": "/login",
  "prerequisiteName": "Login Test",
  "externalId": "JIRA-1234",
  "tagNames": [
    "authentication",
    "critical-path",
    "smoke-test"
  ],
  "folderName": "Authentication Tests"
}'
{
  "discoveryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "testCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string
required

The ID of the test target

Body

application/json
​
name
string
required

A descriptive name for the discovery that clearly identifies its purpose. This will be displayed in the UI and used for reference.

Example:

"Login Flow Validation"

​
prompt
string
required

Detailed instructions for what should be discovered and validated. Be specific about the functionality, conditions, or behaviors to test.

Example:

"Verify that users can successfully log in with valid credentials and see their dashboard."

​
entryPointUrlPath
string | null

The specific URL path where the test should begin execution. For example, '/login' for authentication tests or '/dashboard' for dashboard features.

Example:

"/login"

​
prerequisiteName
string | null

Name of another test case that must be executed before this discovery. The system will resolve this to the appropriate test case within the same test target.

Example:

"Login Test"

​
externalId
string | null

Custom identifier to link this discovery with external systems or tracking tools. Can be used for integration with issue trackers or test management systems.

Example:

"JIRA-1234"

​
tagNames
string[] | null

List of tags to categorize and organize the discovery. Tags help in filtering and grouping related test cases (e.g., 'authentication', 'critical-path', 'regression').

Example:
[
  "authentication",
  "critical-path",
  "smoke-test"
]
​
folderName
string | null

Name of the organizational folder where this discovery should be stored. Helps in maintaining a structured test hierarchy (e.g., 'Authentication Tests', 'User Management').

Example:

"Authentication Tests"

Response

200
application/json
Discovery created successfully
​
discoveryId
string
required

The ID of the created discovery

​
testCaseId
string
required

The ID of the associated test case