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

# Search the management catalog

> Searches the built-in account-visible management catalog, including endpoints that are currently disabled. Enterprise-owned Custom APIs remain available through the catalog listing and detail routes but are not included in this static search index. Returns price-free display metadata, desired enablement, and current platform availability so a dashboard can help a person choose tools before enabling them. Always-on system routes are omitted; a tenant-toggleable Locus Travel route is included when available. This operation does not call a provider or burn credits.



## OpenAPI

````yaml /api-reference/openapi.json post /credits/catalog/search
openapi: 3.1.0
info:
  title: Locus Pro API
  description: >-
    Production is live at https://api.paywithlocus.com/api. Stage remains
    available for evaluation and integration testing at
    https://api.stage.paywithlocus.com/api; credentials, balances, and tenant
    data are isolated by environment. Embedded prepaid credits over the Locus
    pay-per-use catalog. Money and top-up amounts use exact decimal strings (up
    to 6dp). Every burn requires an Idempotency-Key header. Management routes
    accept a tenant secret key or authorized dashboard session as shown per
    operation. Widget routes accept an end-user JWT alone; when a publishable
    key is present it must belong to the JWT's tenant. MCP uses OAuth 2.1
    Authorization Code with PKCE by default and also accepts the explicitly
    documented tenant secret key, end-user JWT, or scoped agent connection
    compatibility credentials. Burns accept the execution credentials shown per
    operation. Publishable keys never authorize management or burns by
    themselves.
  version: 0.6.0
servers:
  - url: https://api.paywithlocus.com/api
    description: Production
  - url: https://api.stage.paywithlocus.com/api
    description: Stage — evaluation and integration testing
security:
  - secretKey: []
tags:
  - name: Authentication
    description: Email-verified self-serve account creation and dashboard identity
  - name: Tenants
    description: Tenant profile, keys, and settings (dashboard session or secret key)
  - name: Workspace members
    description: Invite-only human workspace membership and role administration
  - name: Catalog
    description: Enable/disable APIs and set markups
  - name: Custom APIs
    description: >-
      Available when enabled for the workspace. Enterprise BYOK providers and
      schema-backed custom actions
  - name: End users
    description: End-user accounts, tokens, and allocations
  - name: Top-ups
    description: Locus-hosted checkout top-ups and quotes
  - name: Ledger
    description: Burn/top-up history and earnings
  - name: Webhooks
    description: Signed events, delivery inspection, and replay
  - name: Burn
    description: Metered pay-per-use calls
  - name: Travel routing
    description: >-
      Available when enabled for the workspace. Multi-provider flight search,
      no-dispatch planning, and feedback
  - name: MCP
    description: Stateless Streamable HTTP transport and MCP tool-result contracts
  - name: Okibi Identity
    description: >-
      Available when enabled for the workspace. Okibi identity verification and
      scoped native CLI credential bootstrap
  - name: Widget
    description: End-user JWT surface; a matching publishable key is optional
  - name: Agent-native onboarding
    description: >-
      Self-registration, human Stripe funding handoff, and restricted account
      setup for headless agents
  - name: Agent connections
    description: Scoped, expiring, revocable credentials for agent execution
  - name: Capability routing
    description: Outcome-level web search and research across eligible catalog providers
paths:
  /credits/catalog/search:
    post:
      tags:
        - Catalog
      summary: Search the management catalog
      description: >-
        Searches the built-in account-visible management catalog, including
        endpoints that are currently disabled. Enterprise-owned Custom APIs
        remain available through the catalog listing and detail routes but are
        not included in this static search index. Returns price-free display
        metadata, desired enablement, and current platform availability so a
        dashboard can help a person choose tools before enabling them. Always-on
        system routes are omitted; a tenant-toggleable Locus Travel route is
        included when available. This operation does not call a provider or burn
        credits.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - query
              properties:
                query:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: >-
                    Trimmed natural-language capability, provider, or endpoint
                    query.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 50
                  default: 30
              additionalProperties: false
      responses:
        '200':
          description: Ranked management results
          headers:
            Cache-Control:
              schema:
                type: string
                const: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementCatalogSearchResponse'
        '400':
          description: Body must contain only a valid query and optional limit
        '401':
          description: Missing or invalid management credential
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '500':
          description: Catalog search failed
      security:
        - dashboardSession: []
        - secretKey: []
components:
  schemas:
    ManagementCatalogSearchResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - query
        - count
        - results
      properties:
        success:
          const: true
        query:
          type: string
        count:
          type: integer
          minimum: 0
          maximum: 50
        results:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/ManagementCatalogSearchMatch'
        note:
          type: string
          description: Present when no catalog endpoint matched.
    ManagementCatalogSearchMatch:
      type: object
      additionalProperties: false
      required:
        - slug
        - provider
        - providerName
        - endpoint
        - title
        - description
        - enabled
        - availability
        - unavailableReason
      properties:
        slug:
          type: string
          pattern: ^[^/]+/[^/]+$
        provider:
          type: string
        providerName:
          type: string
        endpoint:
          type: string
        title:
          type: string
        description:
          type: string
        category:
          type: string
        enabled:
          type: boolean
          description: >-
            The account's desired enablement. This is separate from current
            platform availability.
        availability:
          type: string
          enum:
            - available
            - temporarily_unavailable
            - unknown
        unavailableReason:
          type:
            - string
            - 'null'
          enum:
            - delivery_breaker
            - platform_pause
            - null
    InsufficientScopeError:
      type: object
      additionalProperties: false
      required:
        - success
        - error
        - code
        - message
        - requiredScopes
        - presentScopes
      properties:
        success:
          const: false
        error:
          const: Forbidden
        code:
          const: INSUFFICIENT_SCOPE
        message:
          type: string
        requiredScopes:
          type: array
          items:
            $ref: '#/components/schemas/CreditsTenantScope'
          minItems: 1
          uniqueItems: true
        presentScopes:
          type: array
          items:
            $ref: '#/components/schemas/CreditsTenantScope'
          uniqueItems: true
    CreditsTenantScope:
      type: string
      enum:
        - tenant:read
        - tenant:write
        - catalog:write
        - credits:move
        - credentials:manage
        - tokens:manage
        - payouts:manage
        - members:manage
        - widget:read
  responses:
    InsufficientScope:
      description: >-
        The authenticated management credential lacks one or more required
        scopes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InsufficientScopeError'
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Tenant secret key (lcr_…). Server-side only.
    dashboardSession:
      type: http
      scheme: bearer
      description: Locus Pro dashboard session (Cognito).

````