Post apiaiv1kb - Xpert AI

cURL

curl --request POST \
  --url https://api.example.com/api/ai/v1/kb \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Customer service knowledgebase",
  "description": "<string>",
  "permission": "organization",
  "type": "standard",
  "recall": {
    "topK": 10,
    "score": 0.5
  },
  "parserConfig": {
    "chunkSize": 1000,
    "chunkOverlap": 100,
    "delimiter": "; , ."
  },
  "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extKnowledgebaseId": "<string>",
  "copilotModel": {
    "copilotId": "xxxx",
    "modelType": "text-embedding",
    "model": "text-embedding-v4"
  }
}
'

import requests

url = "https://api.example.com/api/ai/v1/kb"

payload = {
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Customer service knowledgebase",
    "description": "<string>",
    "permission": "organization",
    "type": "standard",
    "recall": {
        "topK": 10,
        "score": 0.5
    },
    "parserConfig": {
        "chunkSize": 1000,
        "chunkOverlap": 100,
        "delimiter": "; , ."
    },
    "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "extKnowledgebaseId": "<string>",
    "copilotModel": {
        "copilotId": "xxxx",
        "modelType": "text-embedding",
        "model": "text-embedding-v4"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: 'Customer service knowledgebase',
    description: '<string>',
    permission: 'organization',
    type: 'standard',
    recall: {topK: 10, score: 0.5},
    parserConfig: {chunkSize: 1000, chunkOverlap: 100, delimiter: '; , .'},
    integrationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    extKnowledgebaseId: '<string>',
    copilotModel: {copilotId: 'xxxx', modelType: 'text-embedding', model: 'text-embedding-v4'}
  })
};

fetch('https://api.example.com/api/ai/v1/kb', 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.example.com/api/ai/v1/kb",
  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([
    'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => 'Customer service knowledgebase',
    'description' => '<string>',
    'permission' => 'organization',
    'type' => 'standard',
    'recall' => [
        'topK' => 10,
        'score' => 0.5
    ],
    'parserConfig' => [
        'chunkSize' => 1000,
        'chunkOverlap' => 100,
        'delimiter' => '; , .'
    ],
    'integrationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'extKnowledgebaseId' => '<string>',
    'copilotModel' => [
        'copilotId' => 'xxxx',
        'modelType' => 'text-embedding',
        'model' => 'text-embedding-v4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/ai/v1/kb"

	payload := strings.NewReader("{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/api/ai/v1/kb")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/ai/v1/kb")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}"

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

POST

/

api

/

ai

/

v1

/

kb

cURL

curl --request POST \
  --url https://api.example.com/api/ai/v1/kb \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Customer service knowledgebase",
  "description": "<string>",
  "permission": "organization",
  "type": "standard",
  "recall": {
    "topK": 10,
    "score": 0.5
  },
  "parserConfig": {
    "chunkSize": 1000,
    "chunkOverlap": 100,
    "delimiter": "; , ."
  },
  "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extKnowledgebaseId": "<string>",
  "copilotModel": {
    "copilotId": "xxxx",
    "modelType": "text-embedding",
    "model": "text-embedding-v4"
  }
}
'

import requests

url = "https://api.example.com/api/ai/v1/kb"

payload = {
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Customer service knowledgebase",
    "description": "<string>",
    "permission": "organization",
    "type": "standard",
    "recall": {
        "topK": 10,
        "score": 0.5
    },
    "parserConfig": {
        "chunkSize": 1000,
        "chunkOverlap": 100,
        "delimiter": "; , ."
    },
    "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "extKnowledgebaseId": "<string>",
    "copilotModel": {
        "copilotId": "xxxx",
        "modelType": "text-embedding",
        "model": "text-embedding-v4"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: 'Customer service knowledgebase',
    description: '<string>',
    permission: 'organization',
    type: 'standard',
    recall: {topK: 10, score: 0.5},
    parserConfig: {chunkSize: 1000, chunkOverlap: 100, delimiter: '; , .'},
    integrationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    extKnowledgebaseId: '<string>',
    copilotModel: {copilotId: 'xxxx', modelType: 'text-embedding', model: 'text-embedding-v4'}
  })
};

fetch('https://api.example.com/api/ai/v1/kb', 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.example.com/api/ai/v1/kb",
  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([
    'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => 'Customer service knowledgebase',
    'description' => '<string>',
    'permission' => 'organization',
    'type' => 'standard',
    'recall' => [
        'topK' => 10,
        'score' => 0.5
    ],
    'parserConfig' => [
        'chunkSize' => 1000,
        'chunkOverlap' => 100,
        'delimiter' => '; , .'
    ],
    'integrationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'extKnowledgebaseId' => '<string>',
    'copilotModel' => [
        'copilotId' => 'xxxx',
        'modelType' => 'text-embedding',
        'model' => 'text-embedding-v4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/ai/v1/kb"

	payload := strings.NewReader("{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/api/ai/v1/kb")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/ai/v1/kb")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Customer service knowledgebase\",\n  \"description\": \"<string>\",\n  \"permission\": \"organization\",\n  \"type\": \"standard\",\n  \"recall\": {\n    \"topK\": 10,\n    \"score\": 0.5\n  },\n  \"parserConfig\": {\n    \"chunkSize\": 1000,\n    \"chunkOverlap\": 100,\n    \"delimiter\": \"; , .\"\n  },\n  \"integrationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extKnowledgebaseId\": \"<string>\",\n  \"copilotModel\": {\n    \"copilotId\": \"xxxx\",\n    \"modelType\": \"text-embedding\",\n    \"model\": \"text-embedding-v4\"\n  }\n}"

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Knowledgebase

workspaceId

string<uuid>

required

Integration ID of knowledge base system

name

string

required

Example:

"Customer service knowledgebase"

description

string

required

permission

enum<string>

default:private

required

Knowledgebase Permission

Available options:

private,

organization,

public

Example:

"organization"

type

enum<string>

default:standard

required

Knowledgebase Type

Available options:

standard,

external

Example:

"standard"

recall

object

required

Recall Options

Example:

{ "topK": 10, "score": 0.5 }

parserConfig

object

required

Parser Config

Example:

{
  "chunkSize": 1000,
  "chunkOverlap": 100,
  "delimiter": "; , ."
}

integrationId

string<uuid>

required

Integration ID of knowledge base system

extKnowledgebaseId

string

required

copilotModel

object

required

Copilot embedding model

Example:

{
  "copilotId": "xxxx",
  "modelType": "text-embedding",
  "model": "text-embedding-v4"
}

Response

201 - undefined