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

# List Engines

> List all engines in your organization, including slug, kind, and status.



## OpenAPI

````yaml GET /api/v1/engines
openapi: 3.1.0
info:
  title: Nexio API
  version: '1.0'
  description: |
    Nexio agentic infrastructure API. Configure engines for placement,
    entity analysis, and other patterns. Submit runs, poll for results,
    or subscribe to signed webhook callbacks.
  contact:
    email: support@usenexio.com
    url: https://docs.usenexio.com
servers:
  - url: https://api.usenexio.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: EngineManagement
    description: Create, configure, and manage inference engines.
  - name: Engines
    description: Engine-scoped endpoints for submitting runs and retrieving results.
  - name: Runs
    description: Retrieve and reconcile submitted runs.
  - name: Catalog
    description: >-
      Read current carriers and products extracted for the authenticated
      organization.
  - name: Environments
    description: Isolated tenancy scopes under your org (one live plus non-live sandboxes).
  - name: Webhooks
    description: Manage webhook endpoints for push-based delivery of terminal run events.
paths:
  /api/v1/engines:
    get:
      tags:
        - EngineManagement
      summary: List Engines
      description: |
        Returns all engines for the authenticated organization.

        Engine metadata only: configs are not included. Use
        [Get Engine Config](/api-reference/engines/get-engine-config) to
        retrieve the full configuration for a specific engine.
      operationId: listEngines
      responses:
        '200':
          description: List of engines.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineListResponse'
              example:
                engines:
                  - id: 550e8400-e29b-41d4-a716-446655440000
                    slug: my-engine
                    label: Product Comparison Engine
                    description: Rank offerings from multiple providers.
                    engine_type: placement
                    status: active
                    created_at: '2026-04-01T10:00:00Z'
                    updated_at: '2026-04-01T10:00:00Z'
                  - id: 660e8400-e29b-41d4-a716-446655440001
                    slug: gap-analysis
                    label: Requirements Gap Analysis
                    description: Evaluate current state against requirements and find gaps.
                    engine_type: entity_analysis
                    status: active
                    created_at: '2026-04-02T14:30:00Z'
                    updated_at: '2026-04-03T09:15:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    EngineListResponse:
      type: object
      required:
        - engines
      properties:
        engines:
          type: array
          items:
            $ref: '#/components/schemas/EngineMetadata'
    EngineMetadata:
      type: object
      required:
        - id
        - slug
        - label
        - description
        - engine_type
        - status
        - created_at
        - updated_at
      description: Engine metadata returned by management endpoints.
      properties:
        id:
          type: string
          description: Engine identifier.
        slug:
          type: string
          description: URL-safe engine slug, unique within the organization.
        label:
          type: string
          description: Human-readable engine name.
        description:
          type: string
          description: Optional engine description.
        engine_type:
          type: string
          enum:
            - placement
            - entity_analysis
            - diligence
          description: >
            Engine type. `placement` engines rank provider offerings into
            optimal solutions.

            `entity_analysis` engines evaluate current state against
            requirements and find gaps.

            `diligence` engines verify a claimed event (location, date, what
            happened) and return a

            sourced verdict with an evidence chain.
        status:
          type: string
          enum:
            - active
            - archived
          description: Engine status. Archived engines cannot have their config updated.
        created_at:
          type: string
          format: date-time
          description: RFC 3339 creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: RFC 3339 last-update timestamp.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: |
            Stable snake_case error identifier. Safe to match programmatically.

            Known codes: `invalid_request`, `invalid_input`, `unauthorized`,
            `auth_unavailable`, `rate_limited`, `missing_run_id`,
            `invalid_run_id`, `run_not_found`, `invalid_offerings`,
            `missing_input`, `queue_unreachable`,
            `engine_not_found`, `engine_slug_conflict`, `engine_archived`,
            `invalid_engine_type`, `validation_error`,
            `webhook_not_found`, `webhook_limit_exceeded`, `invalid_url`,
            `invalid_events`, `invalid_description`, `invalid_auth_token`,
            `missing_endpoint_id`, `invalid_endpoint_id`, `missing_delivery_id`,
            `invalid_delivery_id`, `delivery_not_found`,
            `delivery_not_resendable`, `insufficient_capability`,
            `engine_version_required`, `engine_version_exact_required`,
            `engine_version_not_found`, `engine_version_invalid_format`,
            `engine_version_draft_requires_sandbox_key`,
            `engine_version_none_released`, `test_scenario_sandbox_only`,
            `test_scenario_forbidden`, `test_scenario_exact_version_required`,
            `test_scenario_version_not_supported`, `invalid_test_scenario`,
            `request_bound_exceeded`, and `run_cap_exceeded`.
        message:
          type: string
          description: Human-readable error message. May change between versions.
        details:
          description: |
            Optional request-specific details. Request-bound failures use the
            `RequestBoundDetails` object. Validation failures may use an array
            of field issues or another documented object.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unauthorized
            message: Missing or invalid API key
    RateLimited:
      description: Rate limit exceeded. Retry after the window resets.
      headers:
        Retry-After:
          description: Seconds until the rate limit window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rate_limited
            message: Rate limit exceeded
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Send the credential as `Authorization: Bearer <key>`.

        Scoped partner credentials use the exclusive `nxsk_v1_...` namespace.
        Each scoped key is bound at issuance to one organization, one canonical
        named environment, an explicit engine set, and a least-privilege
        capability set. A malformed, unknown, rotated, or revoked `nxsk_` key
        fails closed and is never retried as a legacy key.

        Capabilities used by this API are `runs:write`, `runs:read`,
        `engines:read`, `catalog:read`, `webhooks:manage`,
        `runs:defensibility:read`, `runs:test`, and `converse:use`. Operation
        descriptions name the required capability.
        Grandfathered `nx_live_...` and `nx_test_...` keys retain their existing
        broad access during the compatibility window.

````