Dataset Items

GET /api/v1/datasets/{dataset_id}/versions/{version_id}/items

Get Items

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue

Response

Type: []ItemWithJobStatus

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring
job_statusItemJobStatus(optional)

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items

POST /api/v1/datasets/{dataset_id}/versions/{version_id}/items

Create Item

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue

Request Body

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Response

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items

GET /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}

Get Item

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
idpathstringtrue

Response

Type: ItemWithJobStatus

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring
job_statusItemJobStatus(optional)

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}

PUT /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}

Update Item

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
idpathstringtrue

Request Body

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Response

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Example

curl -X PUT \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}

GET /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}/download

Get Item Image

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
idpathstringtrue

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}/download

POST /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}/upload

Create Item Image

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
idpathstringtrue

Response

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{id}/upload

GET /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{item_id}/jobs

Get Post Processor Jobs

getPostProcessorJobs returns jobs for a specific item

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
item_idpathstringtrue

Response

Type: []PostProcessorJobWithDetails

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
post_processor_iduuid.UUID
dataset_item_iduuid.UUID
dataset_iduuid.UUID
statusstringpending, processing, completed, failed
attemptsint
max_attemptsint
errorstring(optional)
resultstringJSON string of raw model output (optional)
started_attime.Time(optional)
completed_attime.Time(optional)
user_idstring
post_processor_namestring
item_namestring

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{item_id}/jobs

POST /api/v1/datasets/{dataset_id}/versions/{version_id}/items/{item_id}/jobs/{job_id}/retry

Create retry Post Processor Job

retryPostProcessorJob retries a failed job

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
item_idpathstringtrue
job_idpathstringtrue

Response

Type: PostProcessorJob

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
post_processor_iduuid.UUID
dataset_item_iduuid.UUID
dataset_iduuid.UUID
statusstringpending, processing, completed, failed
attemptsint
max_attemptsint
errorstring(optional)
resultstringJSON string of raw model output (optional)
started_attime.Time(optional)
completed_attime.Time(optional)
user_idstring

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/items/{item_id}/jobs/{job_id}/retry

DELETE /api/v1/datasets/{dataset_id}/versions/{version_id}/splits/{split_id}/items/{id}

Delete Item

Parameters

NameInTypeRequired
dataset_idpathstringtrue
version_idpathstringtrue
split_idpathstringtrue
idpathstringtrue

Response

Type: DatasetItem

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
user_idstring
textstring
splits[]*DatasetSplit
annotations[]Annotation
extensionstring

Example

curl -X DELETE \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/datasets/{dataset_id}/versions/{version_id}/splits/{split_id}/items/{id}