Skip to main content
POST
/
v2
/
collections
/
{collectionId}
/
dossier
/
create
Create a dossier
curl --request POST \
  --url https://rest.forestreet.com/v2/collections/{collectionId}/dossier/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "agentId": "<string>",
  "shouldUpdate": false,
  "cacheOnly": false,
  "ignoreCache": false
}
'
{
  "agentId": "<string>",
  "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
collectionId
number | null

The collection ID to which the new dossier belongs.

Query Parameters

​
teamId
integer
required

Unique identifier of the team from which a quota should be consumed.

Required range: x >= 1

Body

application/json
​
query
string
required

The query to create the dossier.

​
agentId
string

The agent ID for the dossier.

​
shouldUpdate
boolean
default:false

Whether the dossier should be updated if it already exists. Default is false.

​
cacheOnly
boolean
default:false

Whether to only return cached results without querying the agent. Default is false.

​
ignoreCache
boolean
default:false

Whether to ignore cached data when creating the dossier and always query the agent. Default is false.

Response

Dossier created successfully

​
agentId
string
required

Unique identifier for the created dossier agent

​
taskId
string<uuid>
required

ID of the task associated with the created dossier agent