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

# Search the catalog

> Each hit carries the slug that GET catalog/{slug} and the plan take. Free text is matched by meaning as well as by name. Reads only; never counts as an activity.



## OpenAPI

````yaml /developers/api-reference/openapi.json get /v1/workflows/catalog/search
openapi: 3.0.0
info:
  title: Engini API
  version: v1
  description: The Engini public API.
servers:
  - url: https://api.engini.io
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Auth
    description: Identify the caller a Developer API request is authenticated as.
  - name: On-prem agents
    description: >-
      Provision and manage agents that run Engini tasks inside a customer's
      network.
  - name: Applications
    description: >-
      Discover the applications (toolkits) available in Engini and their
      connection requirements.
  - name: Tools
    description: Browse and execute the tools exposed by Engini applications.
  - name: Toolsets
    description: Manage toolsets - named groupings of connections and tools.
  - name: McpServers
    description: >-
      Inspect and maintain MCP servers - the account-wide endpoints that expose
      Engini tools and workflows over the Model Context Protocol. Distinct from
      the MCPClient connection kind, which is Engini consuming a third-party MCP
      server.
  - name: Connections
    description: >-
      Manage connections to applications, including OAuth sign-in and
      default-connection selection.
  - name: Folders
    description: >-
      List the folders that organize workflows in each workspace and
      environment.
  - name: Workflows
    description: >-
      List workflows, and build them from a plan: search the catalog, read
      schemas and options, compile, create and update.
  - name: Executions
    description: >-
      Read execution history for workflows, table automations and app business
      rules, including per-step logs and recorded payloads.
  - name: Triggers
    description: >-
      Create triggers that fire when something changes in a connected app, and
      manage the destinations their events are delivered to.
paths:
  /v1/workflows/catalog/search:
    get:
      tags:
        - Workflows
      summary: Search the catalog
      description: >-
        Each hit carries the slug that GET catalog/{slug} and the plan take.
        Free text is matched by meaning as well as by name. Reads only; never
        counts as an activity.
      operationId: Workflows_SearchCatalog
      parameters:
        - name: q
          in: query
          schema:
            type: string
            nullable: true
          x-position: 1
        - name: kind
          in: query
          schema:
            type: string
            nullable: true
          x-position: 2
        - name: app
          in: query
          schema:
            type: string
            nullable: true
          x-position: 3
        - name: top
          in: query
          schema:
            type: integer
            format: int32
            default: 10
          x-position: 4
        - name: table
          in: query
          schema:
            type: string
            format: uuid
            nullable: true
          x-position: 5
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CatalogHit'
        '400':
          description: >-
            Bad request - an invalid parameter or body, or SCOPE_REQUIRED for a
            write with a key that has no workspace (problem+json).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BuilderProblem'
        '401':
          description: Unauthorized - missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden - API_KEY_REQUIRED for a Bearer token or an account-level
            key, PERMISSION_DENIED when the key's user may not create workflows
            here (problem+json); FORBIDDEN, GUEST_NOT_ALLOWED or
            SCOPE_UNRESOLVED when a gate in front of the builder refuses first
            (the ErrorResponse envelope, application/json).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BuilderProblem'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            Not found - the workflow, app, table or connection is not visible to
            this key, or the key's user may not read here (problem+json).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BuilderProblem'
        '429':
          description: >-
            Too many requests - the account's limit (ErrorResponse body) or this
            key's per-operation limit (empty body). Both send Retry-After.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error (problem+json).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BuilderProblem'
      security:
        - Bearer: []
        - ApiKey: []
      x-codeSamples:
        - lang: python
          label: Python
          source: >-
            from engini import Engini


            client = Engini()  # reads ENGINI_API_KEY


            hits = client.workflows.search_catalog(q="post message",
            app="slack", kind="action")
        - lang: typescript
          label: TypeScript
          source: >-
            import { Engini } from "@engini/sdk";


            const client = new Engini(); // reads ENGINI_API_KEY


            const hits = await client.workflows.searchCatalog({ q: "post
            message", app: "slack", kind: "action" });
        - lang: bash
          label: CLI
          source: engini workflows search 'post message' --app slack --kind action
components:
  schemas:
    CatalogHit:
      type: object
      additionalProperties: false
      required:
        - slug
        - kind
        - app
        - name
        - description
        - score
      properties:
        slug:
          type: string
        kind:
          $ref: '#/components/schemas/BuilderKind'
        app:
          type: string
        name:
          type: string
        description:
          type: string
        score:
          type: number
          format: double
    BuilderProblem:
      type: object
      description: >-
        The builder's error body as it is sent (application/problem+json).
        Documentation only: the controller writes it

        from WorkflowBuilderApiError with the HTTP status added.
      additionalProperties: false
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          description: The HTTP status, repeated in the body.
          format: int32
        code:
          type: string
          description: >-
            A stable machine-readable code, such as PLAN_HAS_ERRORS or
            REVISION_CONFLICT.
        path:
          type: string
          description: The request member the refusal is about, when there is one.
          nullable: true
        message:
          type: string
          description: What failed, in plain words.
        fix:
          type: string
          description: What to do about it, when the builder knows.
          nullable: true
        diagnostics:
          type: array
          description: 'With PLAN_HAS_ERRORS: every diagnostic of the refused plan.'
          nullable: true
          items:
            $ref: '#/components/schemas/BuilderDiagnostic'
        currentRevisionId:
          type: integer
          description: 'With REVISION_CONFLICT: the workflow''s revision now.'
          format: int64
          nullable: true
    ErrorResponse:
      type: object
      description: >-
        Unified machine-readable error envelope returned by every non-200
        Developer API response.
      additionalProperties: false
      required:
        - errorCode
        - message
        - requestId
        - timestamp
      properties:
        errorCode:
          type: string
          description: Machine-readable error code identifying the failure.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Identifier of the request, for support/correlation.
        timestamp:
          type: string
          description: Timestamp when the error occurred (ISO 8601).
        details:
          type: array
          description: Per-field validation details, when applicable.
          nullable: true
          items:
            $ref: '#/components/schemas/ErrorDetail'
    BuilderKind:
      type: string
      description: What a plan step asks for. The three kinds are disjoint.
      x-enumNames:
        - Action
        - Trigger
        - Block
      enum:
        - action
        - trigger
        - block
    BuilderDiagnostic:
      type: object
      additionalProperties: false
      required:
        - severity
        - code
        - message
      properties:
        severity:
          type: string
        code:
          type: string
        stepKey:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
        message:
          type: string
    ErrorDetail:
      type: object
      description: A single field-level error detail within an ErrorResponse.
      additionalProperties: false
      required:
        - field
        - issue
      properties:
        field:
          type: string
          description: Name of the field the issue relates to.
        issue:
          type: string
          description: Description of the issue with the field.
  securitySchemes:
    Bearer:
      type: http
      description: Enter your JWT token
      scheme: bearer
      bearerFormat: JWT
    ApiKey:
      type: apiKey
      description: >-
        Opaque Developer API key (prefix `eng_`). Authenticates as the key's
        owner and resolves the account automatically.
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.