Effects Management
Create Effect
post
Authorizations
Path parameters
company_idstring · uuidRequired
Body
titlestring · min: 1Required
descriptionstring | nullOptional
typeone ofOptional
string · enumOptionalPossible values:
product
- Productenvironment
- Environmentprocedure
- Procedure
undefined · enumOptionalPossible values:
nullOptional
Responses
201Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/effects/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"title": "text",
"description": null,
"type": "product",
"attach_options": {
"model": "text",
"comparison": true
}
}
{
"id": "text",
"title": "text",
"description": null,
"is_default": true,
"type": "product",
"datasets": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
],
"updated_at": "2025-10-08T20:53:30.159Z",
"created_at": "2025-10-08T20:53:30.159Z",
"effect_variants": [
{
"id": "text",
"title": "text"
}
],
"attach_options": {
"model": "text",
"comparison": true
}
}
Get Effect info
get
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Responses
200Success
application/json
get
GET /api/v1/companies/{company_id}/effects/{effect_id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"id": "text",
"title": "text",
"description": null,
"is_default": true,
"type": "product",
"datasets": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
],
"updated_at": "2025-10-08T20:53:30.159Z",
"created_at": "2025-10-08T20:53:30.159Z",
"effect_variants": [
{
"id": "text",
"title": "text"
}
],
"attach_options": {
"model": "text",
"comparison": true
}
}
List Effects
get
Authorizations
Path parameters
company_idstring · uuidRequired
Query parameters
qstringOptional
A search term.
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
Responses
200Success
application/json
400Error
application/json
get
GET /api/v1/companies/{company_id}/effects/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "text",
"title": "text",
"description": null,
"is_default": true,
"type": "product",
"datasets": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
],
"updated_at": "2025-10-08T20:53:30.159Z",
"created_at": "2025-10-08T20:53:30.159Z",
"effect_variants": [
{
"id": "text",
"title": "text"
}
],
"attach_options": {
"model": "text",
"comparison": true
}
}
]
}
Update Effect
patch
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
titlestring · min: 1Optional
descriptionstring | nullOptional
typeone ofOptional
string · enumOptionalPossible values:
product
- Productenvironment
- Environmentprocedure
- Procedure
undefined · enumOptionalPossible values:
nullOptional
Responses
200Success
application/json
400Error
application/json
patch
PATCH /api/v1/companies/{company_id}/effects/{effect_id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"title": "text",
"description": null,
"type": "product",
"attach_options": {
"model": "text",
"comparison": true
}
}
{
"id": "text",
"title": "text",
"description": null,
"is_default": true,
"type": "product",
"datasets": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
],
"updated_at": "2025-10-08T20:53:30.159Z",
"created_at": "2025-10-08T20:53:30.159Z",
"effect_variants": [
{
"id": "text",
"title": "text"
}
],
"attach_options": {
"model": "text",
"comparison": true
}
}
Attach Effect to Dataset
post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
datasetsstring · uuid[]Required
Responses
200Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/attach-to-dataset/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"datasets": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"status": "text"
}
Detach Effect from Dataset
post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
datasetsstring · uuid[]Required
Responses
200Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/detach-from-dataset/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"datasets": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"status": "text"
}
Duplicate Effect
post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
titlestring | null · min: 1Optional
descriptionstring | nullOptional
Responses
200Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/duplicate/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"title": null,
"description": null
}
{
"status": "text"
}
Delete Effect(s) in a Bulk Manner
post
Authorizations
Path parameters
company_idstring · uuidRequired
Body
effects_idsstring[]Required
Responses
200Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/effects/bulk-delete/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"effects_ids": [
"text"
]
}
{
"status": "text"
}
Last updated
Was this helpful?