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

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

// Automatically fetches more pages as needed.
for await (const artifact of client.knowledgeBases.artifacts.list('knowledge_base_id')) {
  console.log(artifact.artifact_id);
}
{
  "items": [
    {
      "artifact_id": "<string>",
      "artifact_name": "<string>",
      "artifact_uri": "<string>",
      "status": "Pending",
      "source": "S3",
      "chunks_status": {
        "chunks_completed": 123,
        "chunks_pending": 123,
        "chunks_failed": 123
      },
      "artifact_uri_public": "<string>",
      "status_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": {}
    }
  ],
  "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>

Get artifacts only with the specified status. Accepted values are: Pending, Completed, Failed, Uploading, Deleting Get artifacts only with the specified status. Accepted values are: Pending, Completed, Failed, Uploading, Deleting

Available options:
Pending,
Completed,
Failed,
Uploading,
Deleting
page
integer
default:1

Page number for pagination to be returned by the given endpoint. Starts at page 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. 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

Successful Response

items
ArtifactInfo · object[]
required

The data returned for the current page.

total_item_count
integer
required

The total number of items of the query

current_page
integer
required

The current page number.

items_per_page
integer
required

The number of items per page.