Segments REST API Guide
List all segments
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
List of all segments
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /v3/segments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "PAGINATED",
"data": {
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definition": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"created_at": "2025-08-13T01:56:31.447Z",
"updated_at": "2025-08-13T01:56:31.447Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
]
}
}
Create new segment
Segment successfully created
Bad Request
Unauthorized
Forbidden
Resource not found
Internal Server Error
POST /v3/segments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"model_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definition": "text"
}
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definition": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"created_at": "2025-08-13T01:56:31.447Z",
"updated_at": "2025-08-13T01:56:31.447Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
}
Detail info of a segment
uuid path parameter
Get detail info
Unauthorized
Forbidden
Resource not found
Internal Server Error
GET /v3/segments/{uuid} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definition": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"created_at": "2025-08-13T01:56:31.447Z",
"updated_at": "2025-08-13T01:56:31.447Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
}
Delete segment by uuid
uuid path parameter
Success
Bad Request
Unauthorized
Forbidden
Resource not found
Internal Server Error
DELETE /v3/segments/{uuid} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List all segments for a model
model id path parameter
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
List of all segments for a model
Bad Request
Unauthorized
Forbidden
Resource not found
Internal Server Error
GET /v3/models/{model_id}/segments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "PAGINATED",
"data": {
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definition": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"created_at": "2025-08-13T01:56:31.447Z",
"updated_at": "2025-08-13T01:56:31.447Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
]
}
}
Last updated
Was this helpful?