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

# Get a module

> Returns the module manifest record for the requested module id, including hash, source, and configuration/secrets schemas.



## OpenAPI

````yaml /cyrnel/openapi.json get /modules/{moduleId}
openapi: 3.0.0
info:
  title: Cyrnel API
  description: >-
    Cyrnel is a universal layer that connects AI agents and LLM applications to
    any external service, API, or device regardless of protocol or standard. It
    acts as an adaptive bridge between your AI and the outside world, enabling
    seamless integrations through code execution, async operation handling, and
    built-in observability and security controls.
  version: 1.0.0
servers:
  - url: http://localhost:9371
security: []
paths:
  /modules/{moduleId}:
    get:
      tags:
        - Modules
      summary: Get a module
      description: >-
        Returns the module manifest record for the requested module id,
        including hash, source, and configuration/secrets schemas.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Module identifier.
          required: true
          description: Module identifier.
          name: moduleId
          in: path
      responses:
        '200':
          description: Full module manifest record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleDetails'
        '400':
          description: The moduleId path parameter was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: A bearer token was required but missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: The module could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: >-
            Rate limit exceeded. The request was throttled. Check Retry-After
            header.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Maximum requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the window resets.
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitErrorResponse'
        '500':
          description: The module could not be loaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  schemas:
    ModuleDetails:
      allOf:
        - $ref: '#/components/schemas/Module'
        - type: object
          properties:
            hash:
              type: string
              minLength: 1
              description: Content hash of the installed module archive.
            source:
              type: string
              minLength: 0
              description: Install source URL used to fetch the module archive.
            configSchema:
              type: object
              additionalProperties:
                nullable: true
              description: JSON Schema describing the module configuration object.
            secretsSchema:
              type: object
              additionalProperties:
                nullable: true
              description: JSON Schema describing the module secrets object.
          required:
            - hash
            - source
            - configSchema
            - secretsSchema
      description: Full module manifest record returned by the get module endpoint.
    ApiErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message returned by the API.
      required:
        - error
      description: Standard error envelope returned by the HTTP error middleware.
    RateLimitErrorResponse:
      type: object
      properties:
        error:
          type: string
          enum:
            - rate_limit_exceeded
          description: Error code identifying rate-limit rejection.
        message:
          type: string
          description: Human-readable message with retry instructions.
        retryAfter:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          description: Number of seconds to wait before retrying.
      required:
        - error
        - message
        - retryAfter
      description: Error body returned when a request is rate-limited (HTTP 429).
    Module:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: Module identifier.
        name:
          type: string
          minLength: 1
          description: Module display name.
        type:
          type: string
          enum:
            - adapter
            - environment
          description: Module type.
        description:
          type: string
          description: Human-readable description of the module.
        isBuiltin:
          type: boolean
          description: Whether the module is bundled with the API.
        enabled:
          type: boolean
          description: Whether the module is currently enabled.
        missing:
          type: boolean
          description: Whether the module is installed but has no matching factory loaded.
      required:
        - id
        - name
        - type
        - description
        - isBuiltin
        - enabled
        - missing
      description: Module manifest record returned by the modules endpoints.

````