Create a dossier
curl --request POST \
--url http://localhost:4000/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
}
'import requests
url = "http://localhost:4000/v2/collections/{collectionId}/dossier/create"
payload = {
"query": "<string>",
"agentId": "<string>",
"shouldUpdate": False,
"cacheOnly": False,
"ignoreCache": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
agentId: '<string>',
shouldUpdate: false,
cacheOnly: false,
ignoreCache: false
})
};
fetch('http://localhost:4000/v2/collections/{collectionId}/dossier/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4000",
CURLOPT_URL => "http://localhost:4000/v2/collections/{collectionId}/dossier/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'agentId' => '<string>',
'shouldUpdate' => false,
'cacheOnly' => false,
'ignoreCache' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4000/v2/collections/{collectionId}/dossier/create"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4000/v2/collections/{collectionId}/dossier/create")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/v2/collections/{collectionId}/dossier/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}"
response = http.request(request)
puts response.read_body{
"agentId": "<string>",
"jobId": "<string>"
}{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request - Invalid input parameters"
}{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden - You do not have permission to create a dossier in this collection"
}{
"success": false,
"errorCode": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error - Failed to create dossier"
}Supplier Dossier
Create a dossier
Create a new dossier in the specified collection using AI to generate supplier information
POST
/
v2
/
collections
/
{collectionId}
/
dossier
/
create
Create a dossier
curl --request POST \
--url http://localhost:4000/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
}
'import requests
url = "http://localhost:4000/v2/collections/{collectionId}/dossier/create"
payload = {
"query": "<string>",
"agentId": "<string>",
"shouldUpdate": False,
"cacheOnly": False,
"ignoreCache": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
agentId: '<string>',
shouldUpdate: false,
cacheOnly: false,
ignoreCache: false
})
};
fetch('http://localhost:4000/v2/collections/{collectionId}/dossier/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4000",
CURLOPT_URL => "http://localhost:4000/v2/collections/{collectionId}/dossier/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'agentId' => '<string>',
'shouldUpdate' => false,
'cacheOnly' => false,
'ignoreCache' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4000/v2/collections/{collectionId}/dossier/create"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4000/v2/collections/{collectionId}/dossier/create")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/v2/collections/{collectionId}/dossier/create")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"agentId\": \"<string>\",\n \"shouldUpdate\": false,\n \"cacheOnly\": false,\n \"ignoreCache\": false\n}"
response = http.request(request)
puts response.read_body{
"agentId": "<string>",
"jobId": "<string>"
}{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request - Invalid input parameters"
}{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden - You do not have permission to create a dossier in this collection"
}{
"success": false,
"errorCode": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error - Failed to create dossier"
}Authorizations
apiKeyAuthbearerAuthsessionIdQuery
Query Parameters
Body
application/json