Skip to content

Create a flow test from a prompt and start a recording run

POST
/v1/flows
curl --request POST \
--url https://api.monita.ai/v1/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "prompt": "example", "variables": { "additionalProperty": "example" }, "domainId": "example", "startUrl": "https://example.com", "provider": "cloudflare", "regions": [ "us-west-2" ], "proxies": true }'
Media typeapplication/json
object
name
string
>= 1 characters <= 120 characters
prompt
required
string
>= 8 characters <= 2000 characters
variables
object
key
additional properties
string
<= 500 characters
domainId
string
startUrl
string format: uri
provider
string
Allowed values: cloudflare browserbase
regions
Array<string>
<= 4 items
Allowed values: us-west-2 us-east-1 eu-central-1 ap-southeast-1
proxies
boolean

Created

Media typeapplication/json
object
test
required
object
id
required
string
name
required
string
prompt
required
string
domainId
required
string
nullable
targetDomain
required
string
nullable
variables
required
object
key
additional properties
string
status
required
string
stepsCount
required
number
activeVersion
required
number
nullable
schedule
required
string
nullable <= 24 characters
nextRunAt
required
number
nullable
provider
required
string
Allowed values: cloudflare browserbase
regions
required
Array<string>
proxies
required
boolean
createdAt
required
number
updatedAt
required
number
latestRun
required
object
id
required
string
testId
required
string
versionId
required
string
nullable
status
required
string
trigger
required
string
startedAt
required
number
nullable
finishedAt
required
number
nullable
durationMs
required
number
nullable
pausedMs
required
number
nullable
summary
required
object
stepsTotal
required
number
stepsPassed
required
number
healedSteps
required
number
vendorsFired
required
number
findings
required
number
pausedMs
number
error
required
string
nullable
region
required
string
nullable
createdAt
required
number
run
required
object
id
required
string
testId
required
string
versionId
required
string
nullable
status
required
string
trigger
required
string
startedAt
required
number
nullable
finishedAt
required
number
nullable
durationMs
required
number
nullable
pausedMs
required
number
nullable
summary
required
object
stepsTotal
required
number
stepsPassed
required
number
healedSteps
required
number
vendorsFired
required
number
findings
required
number
pausedMs
number
error
required
string
nullable
region
required
string
nullable
createdAt
required
number
Example
{
"test": {
"schedule": "daily@09:00",
"provider": "cloudflare"
}
}

Advanced-run tier not enabled for this org

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Not found

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Flows worker unavailable

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}