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

# Record a runtime error from the Based engine



## OpenAPI

````yaml /openapi-specs/brainbase-openapi.documented.json post /api/workers/{workerId}/runtime-errors
openapi: 3.0.0
info:
  title: Brainbase REST API
  version: 1.0.3
  description: API documentation for Brainbase REST API
servers:
  - url: https://brainbase-monorepo-api.onrender.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Team
    description: Endpoints related to team functionalities
  - name: Integrations
    description: Endpoints for integrations
  - name: Assets
    description: Endpoints for asset management
  - name: Workers
    description: Endpoints for worker operations
  - name: Flows
    description: Endpoints for flow management
  - name: Voice Deployments
    description: Endpoints for voice deployments
  - name: Voice V1 Deployments
    description: Endpoints for voice v1 deployments
  - name: Voice Deployment Logs
    description: Endpoints for voice deployment logs
  - name: Voice Deployment Outbound Data
    description: Endpoints for voice deployment outbound data
  - name: Chat Deployments
    description: Endpoints for chat deployments
  - name: Chat Deployment Logs
    description: Endpoints for chat deployment logs
  - name: Tags
    description: Endpoints for tag management and worker tag assignment
  - name: Echo
    description: Endpoints for Echo test suites, agents, and scorecards
  - name: Flow Versions
    description: Endpoints for flow version control
  - name: Deployment History
    description: Endpoints for deployment change history
  - name: Deployment Parameters
    description: Endpoints for deployment parameters
  - name: Log Exports
    description: Endpoints for async log export to CSV/JSON
  - name: Logs
    description: >-
      Universal log lookup — fetch any deployment log by ID without needing
      worker or deployment context
  - name: Deployments
    description: >-
      Universal deployment lookup — fetch any deployment by ID without needing
      worker context
paths:
  /api/workers/{workerId}/runtime-errors:
    post:
      tags:
        - Runtime Errors
      summary: Record a runtime error from the Based engine
      parameters:
        - name: workerId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - type
                - service
                - error
              properties:
                type:
                  type: string
                  description: Error type/class (e.g., "ValueError", "RuntimeError")
                service:
                  type: string
                  description: >-
                    Service that generated the error (e.g., "based_engine",
                    "sms")
                error:
                  type: string
                  description: Error message
                traceback:
                  type: string
                  description: Full stack trace
                severity:
                  type: string
                  enum:
                    - warning
                    - error
                    - critical
                  default: error
                functionName:
                  type: string
                  description: Function being executed when error occurred
                lineNumber:
                  type: integer
                  description: Line number in Based code
                metadata:
                  type: object
                  description: Additional context
                deploymentId:
                  type: string
                  description: Deployment ID (optional)
                flowId:
                  type: string
                  description: >-
                    Flow ID (used to lookup deployment if deploymentId not
                    provided)
                bbEngineSessionId:
                  type: string
                  description: Session ID for trace correlation
      responses:
        '201':
          description: Runtime error recorded successfully
        '400':
          description: Missing required fields
        '401':
          description: Unauthorized
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import BrainbaseLabs from 'brainbase-labs';

            const client = new BrainbaseLabs({
              apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
            });

            await client.workers.runtimeErrors.record('workerId', {
              error: 'error',
              service: 'service',
              type: 'type',
            });
        - lang: Python
          source: |-
            import os
            from brainbase_labs import BrainbaseLabs

            client = BrainbaseLabs(
                api_key=os.environ.get("BRAINBASE_LABS_API_KEY"),  # This is the default and can be omitted
            )
            client.workers.runtime_errors.record(
                worker_id="workerId",
                error="error",
                service="service",
                type="type",
            )
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication

````