GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
upload-schedules
import SGPClient from 'sgp';

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

// Automatically fetches more pages as needed.
for await (const uploadScheduleWithViews of client.knowledgeBases.uploadSchedules.list('knowledge_base_id')) {
  console.log(uploadScheduleWithViews.id);
}
{
  "items": [
    {
      "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>"
      },
      "knowledge_base_id": "<string>",
      "knowledge_base_data_source_id": "<string>",
      "chunking_strategy_config": {
        "strategy": "character",
        "separator": "\n\n",
        "chunk_size": 1000,
        "chunk_overlap": 200
      },
      "status": "HEALTHY",
      "status_reason": "<string>",
      "interval": 123,
      "next_run_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "account_id": "<string>"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string

Path Parameters

knowledge_base_id
string
required

Query Parameters

view
enum<string>[]
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
account_id
string

Response

200
application/json

Successful Response

The response is of type object.