Skip to main content

Get dataset types

This page documents read endpoints for dataset types:

  • List all types: GET /dataset-types
  • One type by id: GET /dataset-types/{dataset_type_id}

Get all dataset types

Endpoint: GET /dataset-types

Description

Returns every dataset type configured in Aegis, ordered by id descending (newest lookup rows first). The list is small and stable; use it to map name or label to the integer id expected by GET /datasets when filtering with dataset_type_id.

Parameters

None.

Error responses

  • 401 — Authentication failed.
  • 500 — Server error.

Responses

  • 200 — JSON array of dataset type objects.

Example response (200)

[
{
"id": 2,
"name": "PROPRIETARY",
"label": "Proprietary",
"description": "Dataset created by Aegis."
},
{
"id": 1,
"name": "CUSTOM",
"label": "Custom",
"description": "Dataset created by the user."
}
]
[
{
"id": 0,
"name": "string",
"label": "string",
"description": "string | null"
}
]

curl

curl "https://api.aegisevals.ai/api/v1/dataset-types" \
-H "Authorization: Bearer sk_00000000000000000000000000000000"

Get dataset type by id

Endpoint: GET /dataset-types/{dataset_type_id}

Description

Returns a single dataset type by its primary key.

Parameters

  • dataset_type_id — path integer, the type’s id.

Error responses

  • 401 — Authentication failed.
  • 404 — No dataset type with that id.
  • 500 — Server error.

Responses

  • 200 — JSON object with id, name, label, and optional description.

Example response (200)

{
"id": 1,
"name": "CUSTOM",
"label": "Custom",
"description": "Dataset created by the user."
}

curl

curl "https://api.aegisevals.ai/api/v1/dataset-types/1" \
-H "Authorization: Bearer sk_00000000000000000000000000000000"