GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
artifacts
/
{artifact_id}
/
chunks
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() {
  // Automatically fetches more pages as needed.
  for await (const chunkListResponse of client.knowledgeBases.artifacts.chunks.list(
    'knowledge_base_id',
    'artifact_id',
  )) {
    console.log(chunkListResponse.id);
  }
}

main();
{
  "items": [
    {
      "id": "<string>",
      "text": "<string>",
      "artifact_id": "<string>",
      "chunk_position": 123,
      "metadata": {},
      "user_supplied_metadata": {},
      "status": "Pending",
      "status_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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
​
artifact_id
string
required

Query Parameters

​
chunk_status
enum<string> | null

Filter by the status of the chunks

Available options:
Pending,
Completed,
Failed
​
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
​
items
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.

Patch Artifact InformationCreate chunk for local chunk artifacts