Create a new datasource

POST

knowledge

{knowledge_id}

datasources

curl --request POST \
  --url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "file_id": "<string>",
  "chunking_options": {
    "chunking_configuration": {
      "type": "default"
    },
    "chunking_cleanup_options": {
      "delete_emails": true,
      "delete_credit_cards": true,
      "delete_phone_numbers": true,
      "clean_bullet_points": true,
      "clean_numbered_list": true,
      "clean_unicode": true,
      "clean_dashes": true,
      "clean_whitespaces": true
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    description: '<string>',
    file_id: '<string>',
    chunking_options: {
      chunking_configuration: {type: 'default'},
      chunking_cleanup_options: {
        delete_emails: true,
        delete_credit_cards: true,
        delete_phone_numbers: true,
        clean_bullet_points: true,
        clean_numbered_list: true,
        clean_unicode: true,
        clean_dashes: true,
        clean_whitespaces: true
      }
    }
  })
};

fetch('https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources"

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "file_id": "<string>",
    "chunking_options": {
        "chunking_configuration": { "type": "default" },
        "chunking_cleanup_options": {
            "delete_emails": True,
            "delete_credit_cards": True,
            "delete_phone_numbers": True,
            "clean_bullet_points": True,
            "clean_numbered_list": True,
            "clean_unicode": True,
            "clean_dashes": True,
            "clean_whitespaces": True
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "display_name": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "knowledge_id": "<string>",
  "chunks_count": 123,
  "_id": "01KTRG2896TFH1QXYJ2VK91A0V",
  "description": "<string>",
  "file_id": "<string>",
  "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "update_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

knowledge_id

string

required

The unique identifier of the knowledge base

Body

application/json

display_name

string

The display name for the datasource visible in the UI. If omitted, the display name is derived from the uploaded file. When both display_name and file_id are provided, the provided display_name is prioritized.

description

string | null

The description of the knowledge base

file_id

string

The unique identifier of the file used for datasource creation. If provided, the file is immediately queued for chunking.

chunking_options

object

Configuration options specifying how the datasource file is chunked. Required if file_id is specified. Defaults to standard chunking options if omitted.

Show child attributes

Response

Datasource successfully created

display_name

string

required

The display name of the datasource. Normally the name of the uploaded file

status

enum<string>

required

Available options:

pending,

processing,

completed,

failed,

queued

created

string

required

The date and time the datasource was created

updated

string

required

The date and time the datasource was updated

knowledge_id

string

required

The unique identifier of the knowledge base

chunks_count

number

required

The number of chunks in the datasource

_id

string<ulid>

default:01KTRG2896TFH1QXYJ2VK91A0V

read-only

The unique identifier of the data source

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

description

string | null

The description of the knowledge base

file_id

string | null

The unique identifier of the file used to create the datasource.

created_by_id

string<uuid> | null

read-only

The user ID of the creator of the knowledge base

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

update_by_id

string<uuid> | null

read-only

The user ID of the last user who updated the knowledge base

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

List all datasources

Retrieve a datasource

⌘I

Create a new datasource

curl --request POST \
  --url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "file_id": "<string>",
  "chunking_options": {
    "chunking_configuration": {
      "type": "default"
    },
    "chunking_cleanup_options": {
      "delete_emails": true,
      "delete_credit_cards": true,
      "delete_phone_numbers": true,
      "clean_bullet_points": true,
      "clean_numbered_list": true,
      "clean_unicode": true,
      "clean_dashes": true,
      "clean_whitespaces": true
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    description: '<string>',
    file_id: '<string>',
    chunking_options: {
      chunking_configuration: {type: 'default'},
      chunking_cleanup_options: {
        delete_emails: true,
        delete_credit_cards: true,
        delete_phone_numbers: true,
        clean_bullet_points: true,
        clean_numbered_list: true,
        clean_unicode: true,
        clean_dashes: true,
        clean_whitespaces: true
      }
    }
  })
};

fetch('https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources"

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "file_id": "<string>",
    "chunking_options": {
        "chunking_configuration": { "type": "default" },
        "chunking_cleanup_options": {
            "delete_emails": True,
            "delete_credit_cards": True,
            "delete_phone_numbers": True,
            "clean_bullet_points": True,
            "clean_numbered_list": True,
            "clean_unicode": True,
            "clean_dashes": True,
            "clean_whitespaces": True
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "display_name": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "knowledge_id": "<string>",
  "chunks_count": 123,
  "_id": "01KTRG2896TFH1QXYJ2VK91A0V",
  "description": "<string>",
  "file_id": "<string>",
  "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "update_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Orq SDK

Platform APIs

Gateway APIs

Enterprise APIs (coming soon)

Authorizations

Path Parameters

Body

Response