GET
/
v4
/
knowledge-bases
/
chunks
/
{chunk_id}
Get Chunk and Artifact Information by Chunk ID
curl --request GET \
  --url https://api.egp.scale.com/v4/knowledge-bases/chunks/{chunk_id} \
  --header 'x-api-key: <api-key>'
{
  "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",
  "artifact": {
    "artifact_id": "<string>",
    "knowledge_base_id": "<string>",
    "chunking_strategy_config": {
      "strategy": "character",
      "separator": "\n\n",
      "chunk_size": 1000,
      "chunk_overlap": 200
    },
    "artifact_name": "<string>",
    "artifact_uri": "<string>",
    "artifact_uri_public": "<string>",
    "content_modification_identifier": "<string>",
    "source": "S3",
    "status": "Pending",
    "status_reason": "<string>",
    "checkpoint": "Pending",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>",
    "tags": {}
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

chunk_id
string
required

Response

Successful Response

id
string
required

The id of the chunk

text
string
required

The text of the chunk as stored in the database

artifact_id
string
required

The id of the artifact

chunk_position
integer
required

Chunk position

status
enum<string>
required

Status of the chunk. If Failed or Pending, its possible that the chunk does not reflect in OpenSearch

Available options:
Pending,
Completed,
Failed
artifact
object
required

The information of the artifact this chunk belongs to

metadata
object

Metadata of the chunk which is stored in OpenSearch

user_supplied_metadata
object

Metadata of the chunk which is stored in the database only provided via custom chunking.

status_reason
string

Status reason of the chunk. May be successful

created_at
string<date-time>

Date and time of chunk creation