/api/v1/dataset-items/{id} (GET)

GET

/api/v1/dataset-items/{id}

curl --request GET \
  --url https://api.endless.zaia.app/api/v1/dataset-items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

• API Server

Retrieves a dataset item.

Parameters

Path Parameters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Responses

200

Retrieves a dataset item.

Media typeapplication/json

object

createdAt

required

string format: date-time

id

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

content

required

string

Example

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

401

Unauthorized.

Media typeapplication/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"
  }
}

404

Dataset item not found.

Media typeapplication/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"
  }
}