GET
/
v4
/
knowledge-bases
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const knowledgeBase of client.knowledgeBases.list()) {
    console.log(knowledgeBase.knowledge_base_id);
  }
}

main();
{
  "items": [
    {
      "knowledge_base_id": "<string>",
      "vector_store_id": "<string>",
      "knowledge_base_name": "<string>",
      "embedding_config": {
        "type": "models_api",
        "model_deployment_id": "<string>"
      },
      "metadata": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "connections": [
        {
          "deletion_status": "DELETING",
          "last_uploaded_at": "2023-11-07T05:31:56Z",
          "knowledge_base_data_source": {
            "name": "<string>",
            "description": "<string>",
            "data_source_config": {
              "source": "S3",
              "s3_bucket": "<string>",
              "s3_prefix": "",
              "aws_region": "<string>",
              "aws_account_id": "<string>"
            },
            "tagging_information": {
              "type": "all",
              "tags_to_apply": {}
            },
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "created_by_user_id": "<string>",
            "account_id": "<string>"
          }
        }
      ],
      "artifacts_status": {
        "artifacts_chunking": 123,
        "artifacts_embedding": 123,
        "artifacts_completed": 123,
        "artifacts_pending": 123,
        "artifacts_uploading": 123,
        "artifacts_failed": 123
      },
      "artifact_count": 123,
      "cluster_status": "<string>",
      "created_by_user_id": "<string>"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
account_id
string

Optional search by account_id

​
view
enum<string>[]
Available options:
Connections,
ArtifactCount
​
page
integer
default:1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x >= 1
​
limit
integer
default:100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 <= x <= 10000

Response

200
application/json
Successful Response

The response is of type object.