Create New Conversation

curl --request POST \
  --url https://api.shieldbase.ai/external/conversations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Secret: <api-key>' \
  --data '
{
  "content": "<string>",
  "model": "gpt-5.1",
  "document_ids": [
    "<string>"
  ],
  "user_timezone": "UTC"
}
'

import requests

url = "https://api.shieldbase.ai/external/conversations"

payload = {
    "content": "<string>",
    "model": "gpt-5.1",
    "document_ids": ["<string>"],
    "user_timezone": "UTC"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-API-Key": "<api-key>",
    "X-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-API-Key': '<api-key>',
    'X-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    content: '<string>',
    model: 'gpt-5.1',
    document_ids: ['<string>'],
    user_timezone: 'UTC'
  })
};

fetch('https://api.shieldbase.ai/external/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shieldbase.ai/external/conversations",
  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([
    'content' => '<string>',
    'model' => 'gpt-5.1',
    'document_ids' => [
        '<string>'
    ],
    'user_timezone' => 'UTC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Secret: <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 := "https://api.shieldbase.ai/external/conversations"

	payload := strings.NewReader("{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Secret", "<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("https://api.shieldbase.ai/external/conversations")
  .header("X-Client-ID", "<api-key>")
  .header("X-API-Key", "<api-key>")
  .header("X-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shieldbase.ai/external/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
request["X-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}"

response = http.request(request)
puts response.read_body

POST

external

conversations

Create New Conversation

curl --request POST \
  --url https://api.shieldbase.ai/external/conversations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Secret: <api-key>' \
  --data '
{
  "content": "<string>",
  "model": "gpt-5.1",
  "document_ids": [
    "<string>"
  ],
  "user_timezone": "UTC"
}
'

import requests

url = "https://api.shieldbase.ai/external/conversations"

payload = {
    "content": "<string>",
    "model": "gpt-5.1",
    "document_ids": ["<string>"],
    "user_timezone": "UTC"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-API-Key": "<api-key>",
    "X-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-API-Key': '<api-key>',
    'X-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    content: '<string>',
    model: 'gpt-5.1',
    document_ids: ['<string>'],
    user_timezone: 'UTC'
  })
};

fetch('https://api.shieldbase.ai/external/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shieldbase.ai/external/conversations",
  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([
    'content' => '<string>',
    'model' => 'gpt-5.1',
    'document_ids' => [
        '<string>'
    ],
    'user_timezone' => 'UTC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Secret: <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 := "https://api.shieldbase.ai/external/conversations"

	payload := strings.NewReader("{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Secret", "<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("https://api.shieldbase.ai/external/conversations")
  .header("X-Client-ID", "<api-key>")
  .header("X-API-Key", "<api-key>")
  .header("X-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shieldbase.ai/external/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
request["X-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<string>\",\n  \"model\": \"gpt-5.1\",\n  \"document_ids\": [\n    \"<string>\"\n  ],\n  \"user_timezone\": \"UTC\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

X-Client-ID

string

header

required

X-API-Key

string

header

required

X-Secret

string

header

required

Body

application/json

content

string

required

model

string

default:gpt-5.1

document_ids

string[]

user_timezone

string

default:UTC

Response

200

SSE stream

API Documentation

Endpoint Examples

Create New Conversation

Authorizations

Body

Response