Presets

Content generation presets

List all presets

get

Returns a list of AI instruction presets that can be used when creating content.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

pageintegerOptional

Page number for pagination

Responses

200

A list of presets

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

target_content_typestring · enum · nullableOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

get

/v1/presets

HTTPcURLJavaScriptPython

GET /v1/presets HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

A list of presets

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "target_content_type": "general",
    "created_at": "2026-03-20T12:43:51.206Z",
    "updated_at": "2026-03-20T12:43:51.206Z"
  }
]

Create a new preset

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

namestring · max: 100Required

descriptionstring · max: 500Optional

Responses

201

Preset created

application/json

post

/v1/presets

HTTPcURLJavaScriptPython

POST /v1/presets HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "name": "text",
  "description": "text",
  "presets": {
    "language": "text",
    "location": "text",
    "tone": "seo_optimized",
    "pov": "first_person_singular",
    "article_type": "general",
    "target_length": "short",
    "include_ai_images": true,
    "ai_image_meta": {
      "image_model": "text",
      "image_style": "text",
      "image_count_body": 1,
      "use_brand_colors": true,
      "image_extra_prompt": "text"
    },
    "include_introduction": true,
    "include_conclusion": true,
    "include_faq": true,
    "include_meta_description": true,
    "extra_prompt": "text",
    "knowledge_sources": [
      1
    ]
  }
}

201

Preset created

{
  "id": 1,
  "name": "text",
  "description": "text",
  "target_content_type": "general",
  "created_at": "2026-03-20T12:43:51.206Z",
  "updated_at": "2026-03-20T12:43:51.206Z",
  "presets": {
    "language": "text",
    "location": "text",
    "tone": "seo_optimized",
    "pov": "first_person_singular",
    "article_type": "general",
    "target_length": "short",
    "enable_pplx_fetch": true,
    "include_introduction": true,
    "include_conclusion": true,
    "include_faq": true,
    "include_featured_image": true,
    "include_meta_description": true,
    "include_youtube_videos": true,
    "position_key_takeaways": "none",
    "include_ai_images": true,
    "ai_image_meta": {
      "image_model": "text",
      "image_style": "text",
      "image_count_body": 1,
      "use_brand_colors": true,
      "image_extra_prompt": "text"
    },
    "extra_prompt": "text",
    "knowledge_sources": [
      1
    ]
  }
}

Get a preset by ID

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

The preset ID

Responses

200

The preset with full settings

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

target_content_typestring · enum · nullableOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

get

/v1/presets/{id}

HTTPcURLJavaScriptPython

GET /v1/presets/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

The preset with full settings

{
  "id": 1,
  "name": "text",
  "description": "text",
  "target_content_type": "general",
  "created_at": "2026-03-20T12:43:51.206Z",
  "updated_at": "2026-03-20T12:43:51.206Z",
  "presets": {
    "language": "text",
    "location": "text",
    "tone": "seo_optimized",
    "pov": "first_person_singular",
    "article_type": "general",
    "target_length": "short",
    "enable_pplx_fetch": true,
    "include_introduction": true,
    "include_conclusion": true,
    "include_faq": true,
    "include_featured_image": true,
    "include_meta_description": true,
    "include_youtube_videos": true,
    "position_key_takeaways": "none",
    "include_ai_images": true,
    "ai_image_meta": {
      "image_model": "text",
      "image_style": "text",
      "image_count_body": 1,
      "use_brand_colors": true,
      "image_extra_prompt": "text"
    },
    "extra_prompt": "text",
    "knowledge_sources": [
      1
    ]
  }
}

Update a preset

put

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

The preset ID

Body

application/json

namestring · max: 100Required

descriptionstring · max: 500Optional

Responses

200

Preset updated

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

target_content_typestring · enum · nullableOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-time · nullableOptional

put

/v1/presets/{id}

HTTPcURLJavaScriptPython

PUT /v1/presets/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "name": "text",
  "description": "text",
  "presets": {
    "language": "text",
    "location": "text",
    "tone": "seo_optimized",
    "pov": "first_person_singular",
    "article_type": "general",
    "target_length": "short",
    "include_ai_images": true,
    "ai_image_meta": {
      "image_model": "text",
      "image_style": "text",
      "image_count_body": 1,
      "use_brand_colors": true,
      "image_extra_prompt": "text"
    },
    "include_introduction": true,
    "include_conclusion": true,
    "include_faq": true,
    "include_meta_description": true,
    "extra_prompt": "text",
    "knowledge_sources": [
      1
    ]
  }
}

200

Preset updated

{
  "id": 1,
  "name": "text",
  "description": "text",
  "target_content_type": "general",
  "created_at": "2026-03-20T12:43:51.206Z",
  "updated_at": "2026-03-20T12:43:51.206Z",
  "presets": {
    "language": "text",
    "location": "text",
    "tone": "seo_optimized",
    "pov": "first_person_singular",
    "article_type": "general",
    "target_length": "short",
    "enable_pplx_fetch": true,
    "include_introduction": true,
    "include_conclusion": true,
    "include_faq": true,
    "include_featured_image": true,
    "include_meta_description": true,
    "include_youtube_videos": true,
    "position_key_takeaways": "none",
    "include_ai_images": true,
    "ai_image_meta": {
      "image_model": "text",
      "image_style": "text",
      "image_count_body": 1,
      "use_brand_colors": true,
      "image_extra_prompt": "text"
    },
    "extra_prompt": "text",
    "knowledge_sources": [
      1
    ]
  }
}

Delete a preset

delete

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idintegerRequired

The preset ID

Responses

204

Preset deleted

delete

/v1/presets/{id}

HTTPcURLJavaScriptPython

DELETE /v1/presets/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

204

Preset deleted

No content