Skip to main content
GET
/
api
/
presets
/
{slug}
Get Preset Details
curl --request GET \
  --url https://easy-peasy.ai/api/presets/{slug} \
  --header 'x-api-key: <api-key>'
{
  "slug": "paragraph-writer",
  "title": "Paragraph Writer",
  "description": "Generate paragraphs with the click of a button!",
  "category": [
    "Tools",
    "Content",
    "Social Media",
    "Marketing",
    "Business"
  ],
  "isFree": true,
  "fields": [
    {
      "name": "keywords",
      "label": "What the paragraph is about",
      "type": "textarea",
      "required": true,
      "placeholder": "example: how to optimize your website for search engines",
      "maxLength": 2500
    },
    {
      "name": "extra1",
      "label": "Keywords to include (optional)",
      "type": "text",
      "required": false,
      "placeholder": "example: meta tags, link building, sitemap.xml",
      "maxLength": 1000
    },
    {
      "name": "tone",
      "label": "Tone",
      "type": "text",
      "required": false,
      "placeholder": "example: friendly, funny, cheerful",
      "maxLength": 250
    },
    {
      "name": "length",
      "label": "Output length",
      "type": "radio",
      "required": false,
      "radioOptions": [
        {
          "value": "Short",
          "default": false
        },
        {
          "value": "Medium",
          "default": true
        },
        {
          "value": "Long",
          "default": false
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at https://easy-peasy.ai/settings/api

Headers

x-api-key
string
required

Your API key

Path Parameters

slug
string
required

The preset slug (e.g. custom-generator, blog-post, paragraph-writer)

Response

Successfully retrieved preset details

slug
string

Unique preset identifier

Example:

"paragraph-writer"

title
string

Human-readable preset name

Example:

"Paragraph Writer"

description
string

Short description of what the preset does

Example:

"Generate paragraphs with the click of a button!"

category

Category or categories the preset belongs to

isFree
boolean

Whether this preset is available on the free plan

fields
object[]

Input fields required by this preset. Pass these as body parameters to /api/generate.