Create a research task

Starts an asynchronous Research Agent task and returns a status URL to poll.

POST/api/agents/{agentId}/tasks/create

Path parameters

agentIdstringrequired

Research Agent ID assigned to your organization.

Request body

requiredapplication/json

messagestringrequired

A product model, part number, description, or follow-up answer.

min length 1

attachmentsAttachment[]

default: []

Show properties

Array of Attachment

typeanyrequired

urlstringrequired

An HTTP(S) URL or supported data URL.

mediaTypestringrequired

Media type of the file.

filenamestringrequired

Filename presented to Research Agent.

Responses

202Task accepted.

statusanyrequired

taskIdstringrequired

statusUrlstring<uri>required

400The request body is invalid.

errorstringrequired

detailsobject

401The bearer token is missing or invalid.

errorstringrequired

403The authenticated user cannot access the requested agent.

errorstringrequired

Request

curl -X POST "https://agents.sibi.ai/api/agents/string/tasks/create" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string",
  "attachments": []
}'

const response = await fetch("https://agents.sibi.ai/api/agents/string/tasks/create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "message": "string",
  "attachments": []
})
});

Response

{
  "status": "pending",
  "taskId": "string",
  "statusUrl": "<uri>"
}