Create a flow test from a prompt and start a recording run
POST
/v1/flows
const url = 'https://api.monita.ai/v1/flows';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","prompt":"example","variables":{"additionalProperty":"example"},"domainId":"example","startUrl":"https://example.com","provider":"cloudflare","regions":["us-west-2"],"proxies":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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 }'Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”Media typeapplication/json
object
name
string
prompt
required
string
variables
object
key
additional properties
string
domainId
string
startUrl
string format: uri
provider
string
regions
Array<string>
proxies
boolean
Responses
Section titled “Responses”Created
Media typeapplication/json
object
test
required
object
id
required
string
name
required
string
prompt
required
string
domainId
required
string
targetDomain
required
string
variables
required
object
key
additional properties
string
status
required
string
stepsCount
required
number
activeVersion
required
number
schedule
required
string
nextRunAt
required
number
provider
required
string
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
status
required
string
trigger
required
string
startedAt
required
number
finishedAt
required
number
durationMs
required
number
pausedMs
required
number
summary
required
object
stepsTotal
required
number
stepsPassed
required
number
healedSteps
required
number
vendorsFired
required
number
findings
required
number
pausedMs
number
error
required
string
region
required
string
createdAt
required
number
run
required
object
id
required
string
testId
required
string
versionId
required
string
status
required
string
trigger
required
string
startedAt
required
number
finishedAt
required
number
durationMs
required
number
pausedMs
required
number
summary
required
object
stepsTotal
required
number
stepsPassed
required
number
healedSteps
required
number
vendorsFired
required
number
findings
required
number
pausedMs
number
error
required
string
region
required
string
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"}