PATCH
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
upload-schedules
/
{upload_schedule_id}
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() {
  const uploadSchedule = await client.knowledgeBases.uploadSchedules.update(
    'knowledge_base_id',
    'upload_schedule_id',
  );

  console.log(uploadSchedule.id);
}

main();
{
  "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>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
knowledge_base_id
string
required
​
upload_schedule_id
string
required

Body

application/json
​
chunking_strategy_config
object
​
interval
number
​
next_run_at
string

Response

200
application/json
Successful Response
​
knowledge_base_id
string
required
​
knowledge_base_data_source_id
string
required
​
chunking_strategy_config
object
required
​
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
required

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

​
updated_at
string
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.

​
account_id
string
required

The ID of the account that owns the given entity.

​
status_reason
string
​
next_run_at
string