Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

List all knowledge bases

curl --request GET \
  --url https://api.orq.ai/v2/knowledge \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "_id": "<string>",
      "created": "<string>",
      "key": "<string>",
      "domain_id": "<string>",
      "updated": "<string>",
      "model": "<string>",
      "description": "<string>",
      "path": "Default",
      "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "internal",
      "retrieval_settings": {
        "retrieval_type": "hybrid_search",
        "top_k": 5,
        "threshold": 0,
        "rerank_config": {
          "rerank_model": "<string>",
          "top_k": 5,
          "rerank_threshold": 0.5
        },
        "agentic_rag_config": {
          "model": "<string>"
        }
      }
    }
  ],
  "has_more": true
}

GET

knowledge

List all knowledge bases

curl --request GET \
  --url https://api.orq.ai/v2/knowledge \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "_id": "<string>",
      "created": "<string>",
      "key": "<string>",
      "domain_id": "<string>",
      "updated": "<string>",
      "model": "<string>",
      "description": "<string>",
      "path": "Default",
      "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "internal",
      "retrieval_settings": {
        "retrieval_type": "hybrid_search",
        "top_k": 5,
        "threshold": 0,
        "rerank_config": {
          "rerank_model": "<string>",
          "top_k": 5,
          "rerank_threshold": 0.5
        },
        "agentic_rag_config": {
          "model": "<string>"
        }
      }
    }
  ],
  "has_more": true
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

number

default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

Required range: 1 <= x <= 200

starting_after

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

ending_before

string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

Response

200 - application/json

Knowledge bases retrieved

object

enum<string>

required

Available options:

list

data

object[]

required

Option 1
Option 2

Show child attributes

data._id

string

required

The unique identifier of the knowledge base.

data.created

string

required

The creation date of the knowledge base.

data.key

string

required

The unique key of the knowledge base.

data.domain_id

string

required

The project/domain ID of the knowledge base.

data.updated

string

required

The last update date of the knowledge base.

data.model

string

required

The embeddings model used for the knowledge base.

data.description

string

The description of the knowledge base.

data.path

string

Entity storage path in the format: project/folder/subfolder/...

The first element identifies the project, followed by nested folders (auto-created as needed).

With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.

Example:

"Default"

data.created_by_id

string<uuid> | null

data.updated_by_id

string<uuid> | null

data.type

enum<string>

default:internal

Available options:

internal

data.retrieval_settings

object

The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.

Show child attributes

data.retrieval_settings.retrieval_type

enum<string>

default:hybrid_search

The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.

Available options:

vector_search,

keyword_search,

hybrid_search

data.retrieval_settings.top_k

integer

default:5

The number of results to return from the search.

data.retrieval_settings.threshold

number

default:0

The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned

Required range: 0 <= x <= 1

data.retrieval_settings.rerank_config

object

The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.

Show child attributes

data.retrieval_settings.rerank_config.rerank_model

string

required

The rerank model to use for the knowledge base.

data.retrieval_settings.rerank_config.top_k

integer

default:5

The number of results to return by the reranking model

Required range: 1 <= x <= 100

data.retrieval_settings.rerank_config.rerank_threshold

number

default:0.5

The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned

Required range: 0 <= x <= 1

data.retrieval_settings.agentic_rag_config

object

The Agentic RAG configuration for the knowledge base. If null is provided, Agentic RAG will be disabled.

Show child attributes

data.retrieval_settings.agentic_rag_config.model

string

required

The model to use for the Agentic RAG

has_more

boolean

required

Delete file

Create a knowledge

⌘I

Platform APIs

Gateway APIs

List all knowledge bases

Authorizations

Query Parameters

Response