/api/v1/dataset-items (GET)

GET

/api/v1/dataset-items

const url = 'https://api.endless.zaia.app/api/v1/dataset-items?datasetId=example&pageNumber=1&pageSize=10';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/dataset-items?datasetId=example&pageNumber=1&pageSize=10'

Retrieves multiple dataset items.

Parameters

Query Parameters

datasetId

required

string

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

search

Search term to filter dataset items by name or description.

string

>= 1 characters

Search term to filter dataset items by name or description.

Responses

200

Retrieves all dataset items for the workspace.

application/json

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

updatedAt

required

string format: date-time

datasetId

required

The dataset ID associated with the dataset item.

string format: uuid

description

required

The internal description of the dataset item.

string

>= 3 characters <= 250 characters

enabled

Whether the dataset item is enabled for agent searches.

boolean

default: true

endsAt

The exclusive end of the dataset item availability period.

string format: date-time

nullable

file

required

The file payload or file reference associated with the dataset item.

string

name

required

The display name of the dataset item.

string

>= 3 characters <= 50 characters

sourceType

required

The source type used to classify the dataset item.

string

Allowed values: text document

startsAt

The inclusive start of the dataset item availability period.

string format: date-time

nullable

status

required

The processing status of the dataset item.

string

Allowed values: pending processing completed failed

Example

[
  {
    "enabled": true,
    "endsAt": null,
    "sourceType": "text",
    "startsAt": null,
    "status": "pending"
  }
]

401

Unauthorized.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}