> ## 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.

# List Presets

> Retrieve a list of all available text generation presets (templates). Use this to discover which presets you can pass to the `/api/generate` endpoint.

Optionally filter by category. Only presets with input fields are returned.



## OpenAPI

````yaml GET /api/presets
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:
    get:
      summary: List Presets
      description: >-
        Retrieve a list of all available text generation presets (templates).
        Use this to discover which presets you can pass to the `/api/generate`
        endpoint.


        Optionally filter by category. Only presets with input fields are
        returned.
      operationId: listPresets
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
          description: Your API key
          example: 27feb2bb-aeb4-4a83-9fb6-8f3f2a15885e
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - Social Media
              - Content
              - Business
              - HR
              - Marketing
              - Resume
              - Education
              - Project Management
              - Tools
              - Other
          description: Filter presets by category
          example: Marketing
      responses:
        '200':
          description: Successfully retrieved presets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresetsListResponse'
              example:
                presets:
                  - slug: custom-generator
                    title: Custom Generator
                    description: Generate custom text for any purpose.
                    category:
                      - Tools
                      - Content
                      - Marketing
                      - Other
                      - Social Media
                      - Business
                      - Resume
                    isFree: false
                  - slug: paragraph-writer
                    title: Paragraph Writer
                    description: Generate paragraphs with the click of a button!
                    category:
                      - Tools
                      - Content
                      - Social Media
                      - Marketing
                      - Business
                    isFree: true
                total: 2
                categories:
                  - Social Media
                  - Content
                  - Business
                  - HR
                  - Marketing
                  - Resume
                  - Education
                  - Project Management
                  - Tools
                  - Other
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid API key
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PresetsListResponse:
      type: object
      properties:
        presets:
          type: array
          description: List of available presets
          items:
            $ref: '#/components/schemas/PresetSummary'
        total:
          type: integer
          description: Total number of presets returned
          example: 50
        categories:
          type: array
          items:
            type: string
          description: All available preset categories
          example:
            - Social Media
            - Content
            - Business
            - HR
            - Marketing
            - Resume
            - Education
            - Project Management
            - Tools
            - Other
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid API key
    PresetSummary:
      type: object
      properties:
        slug:
          type: string
          description: Unique preset identifier to pass to `/api/generate`
          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
          example:
            - Tools
            - Content
            - Marketing
        isFree:
          type: boolean
          description: Whether this preset is available on the free plan
          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

````