curl --request GET \
--url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
const data = await response.json();
console.log(data);
{
"status": "IN_PROGRESS"
}
Cases
Get Case Status
Poll the execution status of a case
GET
/
api
/
v1
/
case
/
{caseId}
/
status
curl --request GET \
--url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
const data = await response.json();
console.log(data);
{
"status": "IN_PROGRESS"
}
Check the current execution status of a case. Poll this endpoint until the case reaches a terminal status, then fetch the output via Get Case Results.
Path Parameters
The case ID returned by Initiate Case
Headers
Response
Execution status of the case. One of:
PENDING, IN_PROGRESS, WAITING, COMPLETED, FAILED, CANCELLED, TIMED_OUT, UNKNOWN.Terminal statuses are
COMPLETED, FAILED, CANCELLED and TIMED_OUT — once one of these is returned, the status will not change again.Errors
curl --request GET \
--url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/status",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
const data = await response.json();
console.log(data);
{
"status": "IN_PROGRESS"
}
Was this page helpful?