Get a task
Polls a Research Agent task and returns its current state or result.
GET
/api/agents/{agentId}/tasks/{taskId}Path parameters
agentIdstringrequiredResearch Agent ID assigned to your organization.
taskIdstringrequiredTask ID returned when the task was created.
Responses
200Current task state.
One of:
PendingTask
statusanyrequiredtaskIdstringrequiredCompletedResearchTask
statusanyrequiredtaskIdstringrequiredtaskUrlstring<uri>requiredproductBeingReplacedProductrequiredShow propertiesHide properties
manufacturerstringrequiredmodelstringrequireddescriptionstringrequiredspecificationsstringrequiredimageUrlstring<uri>requiredcandidateReplacementsCandidateReplacement[]requiredShow propertiesHide properties
Array of
CandidateReplacementmanufacturerstringrequiredmodelstringrequireddescriptionstringrequiredspecificationsstringrequiredmsrpnumber | nullrequiredsibiProductIdstring | nullrequiredsibiManufacturerstring | nullrequiredsibiPricenumber | nullrequiredsibiCheckoutLinkstring | nullrequiredmatchReasoningstringrequiredavailableOnSibibooleanrequiredimageUrlstring<uri>requiredCompletedBatchTask
statusanyrequiredtaskIdstringrequiredtaskUrlstring<uri>requiredresearchResultsBatchSuccess | BatchFailure[]requiredShow propertiesHide properties
Array of
BatchSuccess | BatchFailureOne of:
BatchSuccess
labelstringindexintegermin 1
productBeingReplacedProductrequiredShow propertiesHide properties
manufacturerstringrequiredmodelstringrequireddescriptionstringrequiredspecificationsstringrequiredimageUrlstring<uri>requiredcandidateReplacementsCandidateReplacement[]requiredShow propertiesHide properties
Array of
CandidateReplacementmanufacturerstringrequiredmodelstringrequireddescriptionstringrequiredspecificationsstringrequiredmsrpnumber | nullrequiredsibiProductIdstring | nullrequiredsibiManufacturerstring | nullrequiredsibiPricenumber | nullrequiredsibiCheckoutLinkstring | nullrequiredmatchReasoningstringrequiredavailableOnSibibooleanrequiredimageUrlstring<uri>requiredBatchFailure
labelstringindexintegermin 1
errorstringrequiredClarificationTask
statusanyrequiredtaskIdstringrequiredtaskUrlstring<uri>requiredcontextstringquestionQuestionrequiredShow propertiesHide properties
questionstringrequiredoptionsQuestionOption[]requiredmin items 2 · max items 6
Show propertiesHide properties
Array of
QuestionOptionlabelstringrequireddescriptionstring | nullrequiredallowMultiplebooleanrequiredFailedTask
statusanyrequiredtaskIdstringrequiredtaskUrlstring<uri>requirederrorstringrequired401The bearer token is missing or invalid.
errorstringrequired403The authenticated user cannot access the requested agent.
errorstringrequired404The task was not found for this user and agent.
errorstringrequiredRequest
curl -X GET "https://agents.sibi.ai/api/agents/string/tasks/string"const response = await fetch("https://agents.sibi.ai/api/agents/string/tasks/string", {
method: "GET"
});Response
{
"status": "pending",
"taskId": "string"
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}{
"error": "Task not found"
}