Skip to main content
GET
/
Dataset
/
{datasetId}
/
document
List documents in a dataset
curl --request GET \
  --url https://api.starleads.co/Dataset/{datasetId}/document \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "size": 123,
      "status": "<string>",
      "chunkMethod": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "pageNumber": 123,
  "pageSize": 123
}

Authorizations

​
X-Api-Key
string
header
required

Headers

​
X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Path Parameters

​
datasetId
string
required

ID of the dataset.

Query Parameters

​
pageNumber
integer<int32>
default:1

Page number (starts at 1, default: 1).

Required range: x >= 1
​
pageSize
integer<int32>
default:50

Number of items per page (1 to 100, default: 50).

Required range: 1 <= x <= 100
​
keywords
string | null

Optional keyword search filter.

​
run
string | null

Optional status filter for parsing state.

Response

Success

Paginated response containing documents

​
data
object[]

List of documents for the current page

​
total
integer<int32>

Total number of items across all pages

​
pageNumber
integer<int32>

Current page number

​
pageSize
integer<int32>

Number of items per page