Skip to main content
GET
/
v2
/
knowledge
/
{knowledge_id}
/
datasources
/
{datasource_id}
Retrieve a datasource
curl --request GET \
  --url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources/{datasource_id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "01K8VCCVAMWPCQR1FJY0X6WA07",
  "display_name": "<string>",
  "description": "<string>",
  "status": "pending",
  "file_id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "update_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "knowledge_id": "<string>",
  "chunks_count": 123
}

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

datasource_id
string
required

The unique identifier of the datasource.

Response

200 - application/json

Datasource successfully retrieved

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:01K8VCCVAMWPCQR1FJY0X6WA07

The unique identifier of the data source

description
string

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

The user ID of the creator of the knowledge base

update_by_id
string<uuid> | null

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