Skip to main content
GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
upload-schedules
/
{upload_schedule_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const uploadScheduleWithViews = await client.knowledgeBases.uploadSchedules.retrieve(
  'knowledge_base_id',
  'upload_schedule_id',
);

console.log(uploadScheduleWithViews.id);
{
  "knowledge_base_data_source": {
    "name": "<string>",
    "description": "<string>",
    "data_source_config": {
      "source": "<string>",
      "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>",
    "created_by_identity_type": "user",
    "account_id": "<string>"
  },
  "knowledge_base_id": "<string>",
  "knowledge_base_data_source_id": "<string>",
  "chunking_strategy_config": {
    "strategy": "<string>",
    "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>",
  "created_by_identity_type": "user",
  "account_id": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

knowledge_base_id
string
required
upload_schedule_id
string
required

Query Parameters

view
enum<string>[]

Response

Successful Response

knowledge_base_id
string
required
knowledge_base_data_source_id
string
required
chunking_strategy_config
object
required
  • CharacterChunkingStrategyConfig
  • TokenChunkingStrategyConfig
  • CustomChunkingStrategyConfig
  • PreChunkedStrategyConfig
  • EnhancedChunkingStrategyConfig
status
enum<string>
required
Available options:
HEALTHY,
UNHEALTHY,
ERROR,
PAUSED
interval
number
required
id
string
required

The unique identifier of the entity.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

created_by_user_id
string
required

The user who originally created the entity.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
account_id
string
required

The ID of the account that owns the given entity.

knowledge_base_data_source
object
status_reason
string
next_run_at
string<date-time>
I