Skip to main content
POST
/
v1
/
tools
/
web
/
research
Create Web Research Task
curl --request POST \
  --url https://api.sierra.absconsulting.com/v1/tools/web/research \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": "<string>"
}
'
{
  "instructions": "<string>",
  "model": "<string>",
  "researchId": "<string>",
  "status": "<string>"
}

Authorizations

​
Api-Key
string
header
required

Access the API as yourself. You can find your API key in your profile menu in Portal.

Body

application/json

Research instructions and optional output schema.

​
instructions
string
required

Clear, concise instructions for what you would like research on. Instructions should be very simple, almost always a single sentence.

​
outputSchema
object

JSON Schema to enforce structured output, if provided by the user.

Response

OK

​
instructions
string
​
model
string
​
researchId
string
​
status
string