---
title: "Patterns"
method: GET
path: "/patterns"
---

# Patterns

`GET /patterns`

## Request

- The document declares no server URL.
- Auth: none declared

Retrieves application patterns based on resolver information.

Returns:
    ApplicationPatternsResponse: A response containing a list of PatternInfo objects.

## Response `200`

Successful Response

- ApplicationPatternsResponse: The response model for /patterns.
  - `patterns` PatternInfo[], required
    - `name` string, required
    - `alias` string, required
    - `candidates` string[], required
    - `slots` Parameter[]
      - `name` string, required
      - `class_name` string, required
      - `default` unknown
      - `is_variable_keyword` boolean

---

[API](https://skmtc.dev/pingcap/apis/pingcap-linguflow-api.md) - [All operations](https://skmtc.dev/pingcap/apis/pingcap-linguflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pingcap/apis/pingcap-linguflow-api/revisions/1194d2174bed?raw)