curl --request POST \
--url 'https://api-prod.usefini.com/v2/test-suite/runs/preview/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}'
const body = {
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
};
const response = await fetch("https://api-prod.usefini.com/v2/test-suite/runs/preview/public", {
method: "POST",
headers: {
Authorization: "Bearer fini_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify(body),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
import requests
import json
body = json.loads('''
{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}
''')
response = requests.request(
"POST",
"https://api-prod.usefini.com/v2/test-suite/runs/preview/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json=body,
)
response.raise_for_status()
result = response.json()
{
"total": 2,
"readyCaseIds": ["00000000-0000-4000-8000-000000000002"],
"incompleteCases": [{"id": "00000000-0000-4000-8000-000000000027", "name": "Unfinished scenario"}]
}
Test Suite
Preview run readiness
Check selected cases for missing criteria before starting a run.
POST
/
v2
/
test-suite
/
runs
/
preview
/
public
curl --request POST \
--url 'https://api-prod.usefini.com/v2/test-suite/runs/preview/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}'
const body = {
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
};
const response = await fetch("https://api-prod.usefini.com/v2/test-suite/runs/preview/public", {
method: "POST",
headers: {
Authorization: "Bearer fini_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify(body),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
import requests
import json
body = json.loads('''
{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}
''')
response = requests.request(
"POST",
"https://api-prod.usefini.com/v2/test-suite/runs/preview/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json=body,
)
response.raise_for_status()
result = response.json()
{
"total": 2,
"readyCaseIds": ["00000000-0000-4000-8000-000000000002"],
"incompleteCases": [{"id": "00000000-0000-4000-8000-000000000027", "name": "Unfinished scenario"}]
}
Check selected cases for missing criteria before starting a run.
The key needs read scope despite the POST method. This route does not queue execution. It checks case selection and criteria readiness; accepted draft-version fields are not validated or used here. Validate draft choices when starting the run.
Headers
Body parameters
Collection UUID for selection/origin. Every selected case must belong to it. A group must be linked to that collection.
Response
Returnstotal, readyCaseIds and incompleteCases. Cases without effective criteria appear in incompleteCases.
curl --request POST \
--url 'https://api-prod.usefini.com/v2/test-suite/runs/preview/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}'
const body = {
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
};
const response = await fetch("https://api-prod.usefini.com/v2/test-suite/runs/preview/public", {
method: "POST",
headers: {
Authorization: "Bearer fini_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify(body),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
import requests
import json
body = json.loads('''
{
"botId": "00000000-0000-4000-8000-000000000001",
"caseIds": [
"00000000-0000-4000-8000-000000000002",
"00000000-0000-4000-8000-000000000027"
]
}
''')
response = requests.request(
"POST",
"https://api-prod.usefini.com/v2/test-suite/runs/preview/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json=body,
)
response.raise_for_status()
result = response.json()
{
"total": 2,
"readyCaseIds": ["00000000-0000-4000-8000-000000000002"],
"incompleteCases": [{"id": "00000000-0000-4000-8000-000000000027", "name": "Unfinished scenario"}]
}
Was this page helpful?

