Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/dataset-items (POST)

POST
/api/v1/dataset-items
curl --request POST \
  --url https://api.endless.zaia.app/api/v1/dataset-items \
  --header 'Content-Type: application/json' \
  --data '{ "datasetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "file": "example" }'

Creates a new dataset item.

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
datasetId
required

The dataset ID associated with the dataset item.

string format: uuid
file
required

A base64 encoded string with prefix.

string
/^data:.*;base64,/
Examplegenerated
{
  "datasetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "file": "example"
}

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The dataset item was created.

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
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
status
required

The processing status of the dataset item.

string
Allowed values: pending processing completed failed
Example
{
  "status": "pending"
}

401

Seção intitulada “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"
  }
}

403

Seção intitulada “403”

Plan limit exceeded.

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

Seção intitulada “404”

Dataset 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"
  }
}