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

# Run one module immediately

> Execute a single module against one query target and return immediate cards in the same response. This endpoint runs only the provided module and does not require stream consumption.



## OpenAPI

````yaml /api-reference/openapi.json post /search/module/once
openapi: 3.1.0
info:
  title: Osintly API
  version: 1.0.0
  description: OpenAPI specification for the Osintly API service.
  contact:
    name: Osintly
    url: https://docs.osint.ly/api-reference/quick-start
servers:
  - url: https://api.osint.ly
    description: Production
security: []
tags:
  - name: System
    description: Health and service checks
  - name: Auth
    description: Authorization validation
  - name: Search
    description: Create, monitor and retrieve search results
  - name: Usage
    description: Rate limit and usage information
  - name: Radar
    description: Breach intelligence endpoints (free with API key)
  - name: Webhooks
    description: Webhook callback payloads configured from search creation
paths:
  /search/module/once:
    post:
      tags:
        - Search
      summary: Run one module immediately
      description: >-
        Execute a single module against one query target and return immediate
        cards in the same response. This endpoint runs only the provided module
        and does not require stream consumption.
      operationId: runModuleOnce
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModuleRunOnceRequest'
            examples:
              single_module:
                summary: Run X (Twitter) module for one pseudonym
                value:
                  query:
                    type: Pseudonym
                    value: EstePrimeWorld
                  module_id: 2e48da48-0f14-457c-92d4-c44cd68b3fdc
                  cache:
                    mode: prefer
      responses:
        '200':
          description: Module executed and immediate cards returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleRunOnceResponse'
              examples:
                success:
                  value:
                    data:
                      search:
                        id: aff38600-cf11-45cc-a489-8706dcaaab88
                        status: finished
                        created_at: '2026-06-14T19:20:14.209Z'
                        completed_at: '2026-06-14T19:20:16.419Z'
                      module:
                        id: 2e48da48-0f14-457c-92d4-c44cd68b3fdc
                        name: X (Twitter)
                      cards:
                        - x_twitter_001:
                            items:
                              - label: Username
                                value: EstePrimeWorld
                                copy: true
                                isdate: false
                                islink: false
                    meta:
                      environment: production
                      timestamp: '2026-06-14T19:20:16.419Z'
        '400':
          $ref: '#/components/responses/SearchApiError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/SearchApiError'
        '500':
          $ref: '#/components/responses/SearchApiError'
        '503':
          $ref: '#/components/responses/SearchApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    ModuleRunOnceRequest:
      type: object
      required:
        - query
        - module_id
      properties:
        query:
          $ref: '#/components/schemas/SearchQuery'
        module_id:
          type: string
          minLength: 1
          description: >-
            ID of the module to execute. Exactly one module is executed per
            request.
        cache:
          $ref: '#/components/schemas/SearchCache'
      additionalProperties: false
    ModuleRunOnceResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - search
            - module
            - cards
          properties:
            search:
              type: object
              required:
                - id
                - status
                - created_at
                - completed_at
              properties:
                id:
                  type: string
                  format: uuid
                status:
                  type: string
                  enum:
                    - pending
                    - processing
                    - finished
                    - failed
                created_at:
                  type: string
                  format: date-time
                completed_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
            module:
              type: object
              required:
                - id
                - name
              properties:
                id:
                  type: string
                name:
                  type: string
            cards:
              type: array
              items:
                type: object
                additionalProperties: true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    SearchQuery:
      type: object
      required:
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/SearchType'
        value:
          type: string
      additionalProperties: false
    SearchCache:
      type: object
      properties:
        mode:
          type: string
          enum:
            - prefer
            - bypass
          default: prefer
      additionalProperties: false
    ResponseMeta:
      type: object
      required:
        - timestamp
      properties:
        environment:
          type: string
        timestamp:
          type: string
          format: date-time
    SearchApiErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              oneOf:
                - type: string
                - type: array
                  items:
                    $ref: '#/components/schemas/ValidationIssue'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    BasicErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
      additionalProperties: true
    SearchType:
      type: string
      enum:
        - Pseudonym
        - Email Address
        - Domain Name
        - Cryptocurrency
        - IP Address
    ValidationIssue:
      type: object
      required:
        - path
        - message
      properties:
        path:
          type: string
        message:
          type: string
  responses:
    SearchApiError:
      description: Search API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SearchApiErrorResponse'
          examples:
            validation_error:
              value:
                error:
                  code: VALIDATION_ERROR
                  message: Invalid request parameters
                  details:
                    - path: query.value
                      message: query.value must be a valid email
                meta:
                  timestamp: '2026-05-27T12:00:00.000Z'
            rate_limited:
              value:
                error:
                  code: RATE_LIMIT_EXCEEDED
                  message: Rate limit exceeded
                  details: API usage limits have been reached
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
            run_not_found:
              value:
                error:
                  code: RUN_NOT_FOUND
                  message: Search run not available
                  details: No active run is associated with this search
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
            leak_source_not_found:
              value:
                error:
                  code: LEAK_SOURCE_NOT_FOUND
                  message: Leak source not found
                  details: No leaked results source matches 'unknown-source'
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BasicErrorResponse'
          examples:
            unauthorized:
              value:
                success: false
                message: Unauthorized
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````