Effect Level Management

Effect Level is a part of Effect and every request should include Effect ID as a path argument.

Create Level Variant

post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
titlestring · min: 1Required
descriptionstring | nullOptional
promptanyOptionalDefault: {}
statusall ofOptionalDefault: draft
string · enumOptional
  • published - Published
  • draft - Draft
Possible values:
simulation_periodstring | nullOptional
Responses
201Success
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/variants/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "title": "My first variant",
  "description": "My first variant that simulates age 30",
  "status": "draft",
  "prompt": {
    "age": 30
  },
  "simulation_period": "1 00:00:00"
}
{
  "id": "effvar_ZrIXw8kIHiJq3Umx",
  "effect_id": "eff_123",
  "updated_at": "2025-10-08T15:20:51.918808Z",
  "created_at": "2025-10-08T15:20:51.918812Z",
  "title": "My first variant",
  "description": "My first variant that simulates age 30",
  "prompt": {
    "age": 30
  },
  "status": "draft",
  "simulation_period": "1 00:00:00"
}

Update Level Variant

patch
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
variant_idstringRequired
Body
titlestring · min: 1Optional
descriptionstring | nullOptional
promptanyOptionalDefault: {}
statusall ofOptionalDefault: draft
string · enumOptional
  • published - Published
  • draft - Draft
Possible values:
simulation_periodstring | nullOptional
Responses
200Success
application/json
patch
PATCH /api/v1/companies/{company_id}/effects/{effect_id}/variants/{variant_id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "title": "My first variant",
  "description": "My first variant that simulates age 30",
  "status": "draft",
  "prompt": {
    "age": 30
  },
  "simulation_period": "1 00:00:00"
}
{
  "id": "effvar_ZrIXw8kIHiJq3Umx",
  "effect_id": "eff_123",
  "updated_at": "2025-10-08T15:20:51.918808Z",
  "created_at": "2025-10-08T15:20:51.918812Z",
  "title": "My first variant",
  "description": "My first variant that simulates age 30",
  "prompt": {
    "age": 30
  },
  "status": "draft",
  "simulation_period": "1 00:00:00"
}

List Level Variants

get
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
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
get
GET /api/v1/companies/{company_id}/effects/{effect_id}/variants/ 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": "effvar_ZrIXw8kIHiJq3Umx",
      "effect_id": "eff_123",
      "updated_at": "2025-10-08T15:20:51.918808Z",
      "created_at": "2025-10-08T15:20:51.918812Z",
      "title": "My first variant",
      "description": "My first variant that simulates age 30",
      "prompt": {
        "age": 30
      },
      "status": "draft",
      "simulation_period": "1 00:00:00"
    }
  ]
}

Get Effect Level Info

get
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
variant_idstringRequired
Responses
200Success
application/json
get
GET /api/v1/companies/{company_id}/effects/{effect_id}/variants/{variant_id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "effvar_ZrIXw8kIHiJq3Umx",
  "effect_id": "eff_123",
  "updated_at": "2025-10-08T15:20:51.918808Z",
  "created_at": "2025-10-08T15:20:51.918812Z",
  "title": "My first variant",
  "description": "My first variant that simulates age 30",
  "prompt": {
    "age": 30
  },
  "status": "draft",
  "simulation_period": "1 00:00:00"
}

Delete Effect Level(s) in a Bulk Manner

post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
Body
variants_idsstring[]Required
Responses
200Success
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/variants/bulk-delete/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "variants_ids": [
    "text"
  ]
}
{
  "status": "text"
}

Duplicate Effect Level

post
Authorizations
Path parameters
company_idstring · uuidRequired
effect_idstringRequired
variant_idstringRequired
Body
titlestring | null · min: 1Optional
Responses
200Success
application/json
post
POST /api/v1/companies/{company_id}/effects/{effect_id}/variants/{variant_id}/duplicate/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "title": null
}
{
  "status": "text"
}
PreviousAPI for SkinGPTNextEffects Management

Last updated

Was this helpful?