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

# Flows - List flows

> Returns all flows **published as tools** that the authenticated user can execute.
Each item includes the flow identifier, name, and tool metadata.

Flows are visual AI pipelines built in [Magnific Spaces](https://www.magnific.com/spaces).
Each flow chains together multiple AI tools (upscale, generate, edit, etc.) and can be executed via API.

**Use this endpoint to discover** runnable flows, then call the detail endpoint to get input definitions before running them.




## OpenAPI

````yaml get /v1/ai/flows
openapi: 3.0.0
info:
  description: >-
    The Magnific API is your gateway to a vast collection of high-quality
    digital resources for your applications and projects. As a leading platform,
    it offers a wide range of graphics, including vectors, photos,
    illustrations, icons, PSD templates, and more, all curated by talented
    designers from around the world.
  title: Magnific API
  version: 1.0.0
servers:
  - description: B2B API Production V1
    url: https://api.magnific.com
security:
  - magnificApiKey: []
paths:
  /v1/ai/flows:
    get:
      tags:
        - flows
      summary: Flows - List flows
      description: >
        Returns all flows **published as tools** that the authenticated user can
        execute.

        Each item includes the flow identifier, name, and tool metadata.


        Flows are visual AI pipelines built in [Magnific
        Spaces](https://www.magnific.com/spaces).

        Each flow chains together multiple AI tools (upscale, generate, edit,
        etc.) and can be executed via API.


        **Use this endpoint to discover** runnable flows, then call the detail
        endpoint to get input definitions before running them.
      operationId: list_flows
      parameters:
        - description: Filter flows by name (case-insensitive substring match).
          example: cartoon
          in: query
          name: search
          required: false
          schema:
            maxLength: 200
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - sqid: uqzQLDr2Aw
                    name: Sketch to Realism
                    tool_metadata:
                      icon: workflow
                      description_key: null
                      translation_key: null
                      category: general
                      sort_order: 999
                      total_cost: 5
                  - sqid: n0LYQDBl58
                    name: Product Photoshoot
                    tool_metadata:
                      icon: workflow
                      description_key: null
                      translation_key: null
                      category: general
                      sort_order: 999
                      total_cost: 8
                  - sqid: hCivqLJltZ
                    name: Anime Style Transfer
                    tool_metadata:
                      icon: workflow
                      description_key: null
                      translation_key: null
                      category: general
                      sort_order: 999
                      total_cost: 5
              schema:
                $ref: '#/components/schemas/list_flows_200_response'
          description: OK - List of flows.
        '401':
          content:
            application/json:
              examples:
                invalid_api_key:
                  summary: API key is not valid
                  value:
                    message: Invalid API key
                missing_api_key:
                  summary: API key is not provided
                  value:
                    message: Missing API key
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
          description: >-
            Unauthorized - The client must authenticate itself to get the
            requested response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_500_response'
          description: >-
            Internal Server Error - The server has encountered a situation it
            doesn't know how to handle.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_503_response'
          description: Service Unavailable
components:
  schemas:
    list_flows_200_response:
      example:
        data:
          - name: Sketch to Realism
            tool_metadata:
              total_cost: 5
              icon: workflow
              translation_key: translation_key
              description_key: description_key
              category: general
              sort_order: 999
            sqid: uqzQLDr2Aw
          - name: Sketch to Realism
            tool_metadata:
              total_cost: 5
              icon: workflow
              translation_key: translation_key
              description_key: description_key
              category: general
              sort_order: 999
            sqid: uqzQLDr2Aw
      properties:
        data:
          items:
            $ref: '#/components/schemas/flow-summary'
          type: array
      required:
        - data
      type: object
    get_all_style_transfer_tasks_400_response:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    get_all_style_transfer_tasks_500_response:
      example:
        message: Internal Server Error
      properties:
        message:
          example: Internal Server Error
          type: string
      type: object
    get_all_style_transfer_tasks_503_response:
      example:
        message: Service Unavailable. Please try again later.
      properties:
        message:
          example: Service Unavailable. Please try again later.
          type: string
      type: object
    flow-summary:
      description: Summary of a flow as returned in list endpoints.
      example:
        name: Sketch to Realism
        tool_metadata:
          total_cost: 5
          icon: workflow
          translation_key: translation_key
          description_key: description_key
          category: general
          sort_order: 999
        sqid: uqzQLDr2Aw
      properties:
        sqid:
          description: Short unique identifier of the flow.
          example: uqzQLDr2Aw
          type: string
        name:
          description: Human-readable name of the flow.
          example: Sketch to Realism
          type: string
        tool_metadata:
          $ref: '#/components/schemas/tool-metadata'
      type: object
    tool-metadata:
      description: Metadata about the tool (UI hints, cost, categorization).
      example:
        total_cost: 5
        icon: workflow
        translation_key: translation_key
        description_key: description_key
        category: general
        sort_order: 999
      properties:
        icon:
          description: Icon identifier for UI rendering.
          example: workflow
          type: string
        description_key:
          description: Translation key for the tool description.
          nullable: true
          type: string
        translation_key:
          description: Translation key for the tool name.
          nullable: true
          type: string
        category:
          description: Category for grouping tools.
          example: general
          type: string
        sort_order:
          description: Display order within category.
          example: 999
          type: integer
        total_cost:
          description: Total credit cost per execution (sum of all workflow nodes).
          example: 5
          type: integer
      type: object
  securitySchemes:
    magnificApiKey:
      description: >
        Your Magnific API key. Required for authentication. [Learn how to obtain
        an API key](https://docs.magnific.com/quickstart)
      in: header
      name: x-magnific-api-key
      type: apiKey

````