GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
uploads
/
{upload_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 knowledgeBaseUpload = await client.knowledgeBases.uploads.retrieve('knowledge_base_id', 'upload_id');

  console.log(knowledgeBaseUpload.upload_id);
}

main();
{
  "upload_id": "<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": "Running",
  "status_reason": "<string>",
  "artifacts_status": {
    "artifacts_chunking": 123,
    "artifacts_embedding": 123,
    "artifacts_completed": 123,
    "artifacts_pending": 123,
    "artifacts_uploading": 123,
    "artifacts_failed": 123
  },
  "artifacts": [
    {
      "artifact_id": "<string>",
      "artifact_name": "<string>",
      "artifact_uri": "<string>",
      "artifact_uri_public": "<string>",
      "status": "<string>",
      "status_reason": "<string>",
      "source": "S3",
      "chunks_status": {
        "chunks_completed": 123,
        "chunks_pending": 123,
        "chunks_failed": 123
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": {}
    }
  ],
  "created_by_schedule_id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
knowledge_base_id
string
required
​
upload_id
string
required

Query Parameters

​
include_artifact_list
boolean
default:true

Response

200
application/json
Successful Response
​
upload_id
string
required

Unique ID of the upload job.

​
data_source_config
object
required

Configuration for downloading data from source.

​
created_at
string
required

The timestamp at which the upload job started.

​
updated_at
string
required

The timestamp at which the upload job was last updated.

​
status
enum<string>
required

Sync status

Available options:
Running,
Completed,
Failed,
Canceled
​
artifacts_status
object
required

Number of artifacts in each of the various states, such as completed and failed for this upload. This includes artifacts for this data source that are retried.

​
artifacts
object[]
required

List of info for each artifacts associated with this upload. This includes artifacts for this data source that are retried.

​
chunking_strategy_config
object

Configuration for chunking the text content of each artifact.

​
status_reason
string

Reason for the upload job's status.

​
created_by_schedule_id
string

Id of the upload schedule that triggered this upload_id. Null if triggered manually.