> ## Documentation Index
> Fetch the complete documentation index at: https://docs.easy-peasy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Preset Details

> Retrieve the full configuration for a specific preset, including all input fields and their constraints.

Use this to understand exactly which parameters to pass when calling `/api/generate` with this preset.



## OpenAPI

````yaml GET /api/presets/{slug}
openapi: 3.0.1
info:
  title: Easy-Peasy.AI API
  description: >-
    OpenAPI Specifications for the Easy-Peasy.AI API.


    All API requests must be authenticated with an API key. Include the
    `x-api-key` API key in the request header with all requests. You can get the
    API key [here](https://easy-peasy.ai/settings/api).
  version: 1.0.4
servers:
  - url: https://easy-peasy.ai
security:
  - apiKeyAuth: []
paths:
  /api/presets/{slug}:
    get:
      summary: Get Preset Details
      description: >-
        Retrieve the full configuration for a specific preset, including all
        input fields and their constraints.


        Use this to understand exactly which parameters to pass when calling
        `/api/generate` with this preset.
      operationId: getPreset
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
          description: Your API key
          example: 27feb2bb-aeb4-4a83-9fb6-8f3f2a15885e
        - name: slug
          in: path
          required: true
          schema:
            type: string
          description: >-
            The preset slug (e.g. `custom-generator`, `blog-post`,
            `paragraph-writer`)
          example: paragraph-writer
      responses:
        '200':
          description: Successfully retrieved preset details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresetDetailResponse'
              example:
                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
        '400':
          description: Missing slug parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Missing slug parameter
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid API key
        '404':
          description: Preset not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Preset not found
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PresetDetailResponse:
      type: object
      properties:
        slug:
          type: string
          description: Unique preset identifier
          example: paragraph-writer
        title:
          type: string
          description: Human-readable preset name
          example: Paragraph Writer
        description:
          type: string
          description: Short description of what the preset does
          example: Generate paragraphs with the click of a button!
        category:
          description: Category or categories the preset belongs to
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        isFree:
          type: boolean
          description: Whether this preset is available on the free plan
        fields:
          type: array
          description: >-
            Input fields required by this preset. Pass these as body parameters
            to `/api/generate`.
          items:
            $ref: '#/components/schemas/PresetField'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid API key
    PresetField:
      type: object
      properties:
        name:
          type: string
          description: Field name to use as the request body key in `/api/generate`
          example: keywords
        label:
          type: string
          description: Human-readable label for the field
          example: What the paragraph is about
        type:
          type: string
          description: Field input type
          enum:
            - text
            - textarea
            - select
            - radio
            - number
            - checkbox
            - hidden
          example: textarea
        required:
          type: boolean
          description: Whether this field is required
          example: true
        description:
          type: string
          description: Additional guidance for the field
        placeholder:
          type: string
          description: Example value for the field
          example: 'example: how to optimize your website for search engines'
        maxLength:
          type: integer
          description: Maximum character length for the field value
          example: 2500
        options:
          type: array
          items:
            type: string
          description: Available options for `select` type fields
        radioOptions:
          type: array
          description: Available options for `radio` type fields
          items:
            type: object
            properties:
              value:
                type: string
                description: Option value
                example: Medium
              default:
                type: boolean
                description: Whether this option is selected by default
                example: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        https://easy-peasy.ai/settings/api

````