Skip to main content
GET
Get Preset Details

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.