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

# Get Vibes

> Returns vibe IDs and names for all system vibes and custom user vibes accessible to the authenticated user. Pass the `id` as `presentation_options.vibe_id` on a generation request.

Retrieve the vibes available to the authenticated user.

A **vibe** is a visual aesthetic preset (mood, palette, illustration style) that gets applied to creative slide variants. This endpoint returns both system vibes and any custom vibes you have created. Use the returned `id` values as `presentation_options.vibe_id` when generating presentations.

<Note>
  Vibes are applied through creative image variants. When you pass `vibe_id`, you must also set `image_options.num_image_variants >= 1` on the generation request.
</Note>

***

## Response

| Field   | Type  | Description                                       |
| ------- | ----- | ------------------------------------------------- |
| `vibes` | array | List of vibes available to the authenticated user |

### Vibe Object

| Field    | Type   | Description                                                      |
| -------- | ------ | ---------------------------------------------------------------- |
| `id`     | string | Unique vibe identifier to pass as `presentation_options.vibe_id` |
| `name`   | string | Human-readable vibe display name                                 |
| `source` | string | Either `system` (built-in) or `custom` (created by the user)     |

***

## Example Request

```bash theme={null}
curl -X GET "https://slides-api.getalai.com/api/v1/vibes" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Example Response

```json theme={null}
{
  "vibes": [
    {
      "id": "b8e3a9ae-f36c-458b-a816-acd5f43072d3",
      "name": "Standard",
      "source": "system"
    },
    {
      "id": "f1c2d3e4-5678-90ab-cdef-1234567890ab",
      "name": "Neon Dreams",
      "source": "system"
    },
    {
      "id": "a1b2c3d4-5678-90ab-cdef-fedcba987654",
      "name": "My Brand Vibe",
      "source": "custom"
    }
  ]
}
```

***

## Using a Vibe ID in Presentation Generation

```bash theme={null}
curl -X POST "https://slides-api.getalai.com/api/v1/generations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input_text": "Launch announcement for our new product line",
    "presentation_options": {
      "title": "Product Launch",
      "vibe_id": "f1c2d3e4-5678-90ab-cdef-1234567890ab",
      "slide_range": "6-10"
    },
    "image_options": {
      "num_image_variants": 1
    }
  }'
```


## OpenAPI

````yaml GET /api/v1/vibes
openapi: 3.1.0
info:
  title: Alai API
  description: API endpoints for programmatic access to Alai presentation generation
  version: 1.0.0
servers:
  - url: https://slides-api.getalai.com
security:
  - BearerAuth: []
paths:
  /api/v1/vibes:
    get:
      tags:
        - External API
      summary: List available vibes
      description: >-
        Returns vibe IDs and names for all system vibes and custom user vibes
        accessible to the authenticated user. Pass the `id` as
        `presentation_options.vibe_id` on a generation request.
      operationId: get_vibes_api_v1_vibes_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVibesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetVibesResponse:
      properties:
        vibes:
          items:
            $ref: '#/components/schemas/VibeSummary'
          type: array
          title: Vibes
          description: Vibes available to the authenticated user
      type: object
      required:
        - vibes
      title: GetVibesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    VibeSummary:
      properties:
        id:
          type: string
          title: Id
          description: Unique vibe identifier
        name:
          type: string
          title: Name
          description: Vibe display name
        source:
          type: string
          title: Source
          description: '''system'' or ''custom'''
      type: object
      required:
        - id
        - name
        - source
      title: VibeSummary
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your Alai API key. Get one from your account settings at app.getalai.com

````