GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
uploads
JavaScript
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 upload of client.knowledgeBases.uploads.list('knowledge_base_id')) {
  console.log(upload.id);
}
{
  "items": [
    {
      "id": "<string>",
      "knowledge_base_id": "<string>",
      "data_source_idempotency_key": "<string>",
      "data_source_config": {
        "source": "S3",
        "s3_bucket": "<string>",
        "s3_prefix": "",
        "aws_region": "<string>",
        "aws_account_id": "<string>"
      },
      "chunking_strategy_config": {
        "strategy": "character",
        "separator": "\n\n",
        "chunk_size": 1000,
        "chunk_overlap": 200
      },
      "created_at": "<string>",
      "updated_at": "<string>",
      "status": "<string>",
      "status_reason": "<string>",
      "created_by_schedule_id": "<string>"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
knowledge_base_id
string
required

Query Parameters

​
status
enum<string>
Available options:
Running,
Completed,
Failed,
Canceled
​
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.