Skip to main content
POST
/
apiKey
/
v3
/
test-targets
/
{testTargetId}
/
batch-generations
Create a batch generation
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v3/test-targets/{testTargetId}/batch-generations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "prompt": "<string>",
  "imageUrls": [
    "<string>"
  ],
  "entryPointUrlPath": "<string>",
  "environmentId": "<string>",
  "prerequisiteId": "<string>",
  "baseUrl": "<string>",
  "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"
  },
  "guessDependency": false
}'
{
  "batchGenerationId": "826c15af-644b-4b28-89b4-f50ff34e46b7"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string<uuid>
required

ID of the test target

Body

application/json
​
prompt
string

Prompt to generate the test cases in this batch generation

​
imageUrls
string[]

Image URLs to generate the test cases in this batch generation

​
entryPointUrlPath
string | null

Entry point URL path, where the batch generation will start

​
environmentId
string | null

Environment ID, where the batch generation will be executed

​
prerequisiteId
string | null

Prerequisite ID, which will be executed before the batch generation

​
baseUrl
string | null

Base URL, where the batch generation will be executed

​
context
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
​
guessDependency
boolean | null
default:false

Guess dependency for the batch generation

Response

Batch generation created successfully

​
batchGenerationId
string<uuid>

Unique identifier for the batch generation

Example:

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