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

# Log

> Enqueues a single log for background delivery via the SDK worker (singleton after olira.init()).

```python theme={null}
olira.log(
    log_type: OliraLogType,
    patient_id: str,
    payload: dict[str, Any] | None = None,
    trace: OliraTrace | None = None,
    timestamp: str | None = None,
    metadata: dict[str, Any] | None = None,
) -> None
```

**Requires scope:** `sdk:event-log`

The worker batches and POSTs to /v1/logs/batch. Returns immediately after enqueue unless the queue rejects the event.

## Parameters

<ParamField body="log_type" type="OliraLogType" required>
  Catalog log type enum value.
</ParamField>

<ParamField body="patient_id" type="str" required>
  Olira patient id. Must not be empty; SDK rejects obvious PII patterns.
</ParamField>

<ParamField body="payload" type="dict[str, Any] | None">
  Event-specific JSON payload (≤512 KB wire limit per event).
</ParamField>

<ParamField body="trace" type="OliraTrace | None">
  Optional linkage to your object\_type / object\_id.
</ParamField>

<ParamField body="timestamp" type="str | None">
  ISO 8601 timestamp; omit for server default.
</ParamField>

<ParamField body="metadata" type="dict[str, Any] | None">
  Arbitrary key/value context stored alongside the event, separate from the typed payload. Surfaced in the Olira Console event detail panel.
</ParamField>

## Returns

`None`

## Raises

| Exception         | When                                                                                                                  |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `OliraError`      | olira.init() was not called, or the background queue could not accept the event.                                      |
| `ValidationError` | Client-side validation failed (e.g. patient\_id rules, payload too large).                                            |
| `AuthError`       | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.                                      |
| `ServerError`     | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status\_code when applicable. |
| `RateLimitError`  | HTTP 429 — rate limited; check retry\_after (seconds).                                                                |
| `NetworkError`    | Connection timeout, DNS failure, or read error after retries.                                                         |

<RequestExample>
  ```python Python theme={null}
  import olira
  from olira import OliraLogType

  olira.init(api_key="YOUR_API_KEY")
  olira.log(
      log_type=OliraLogType.SYMPTOM_REPORT,
      patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      payload={"symptoms": []},
  )
  ```

  ```http HTTP theme={null}
  POST /v1/logs/batch
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

  {
    "logs": [
      {
        "log_type": "symptom_report",
        "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
        "payload": { "symptoms": [] },
        "context": {
          "service": "",
          "sdk_version": "…",
          "sdk_language": "python"
        }
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  # Returns None once the event is accepted into the SDK queue
  ```

  ```json 401 theme={null}
  {
    "error": true,
    "status_code": 401,
    "error_type": "authentication_error",
    "message": "Could not validate credentials",
    "details": [
      {
        "type": "authentication_error",
        "message": "Could not validate credentials"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 403 theme={null}
  {
    "error": true,
    "status_code": 403,
    "error_type": "authorization_error",
    "message": "Insufficient OAuth scope for this endpoint",
    "details": [
      {
        "type": "authorization_error",
        "message": "Insufficient OAuth scope for this endpoint"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 404 theme={null}
  {
    "error": true,
    "status_code": 404,
    "error_type": "not_found_error",
    "message": "Patient not found",
    "details": [
      {
        "type": "not_found_error",
        "message": "Patient not found"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 422 theme={null}
  {
    "error": true,
    "status_code": 422,
    "error_type": "validation_error",
    "message": "Request validation failed (1 error)",
    "details": [
      {
        "type": "missing",
        "message": "Field required",
        "field": "patient_id",
        "location": ["body", "patient_id"],
        "input_value": null
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 429 theme={null}
  {
    "error": true,
    "status_code": 429,
    "error_type": "server_error",
    "message": "Rate limit exceeded",
    "details": [
      {
        "type": "rate_limit",
        "message": "Too many requests; retry after backoff"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 500 theme={null}
  {
    "error": true,
    "status_code": 500,
    "error_type": "internal_server_error",
    "message": "An internal server error occurred",
    "details": [
      {
        "type": "internal_server_error",
        "message": "An unexpected error occurred while processing your request"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```
</ResponseExample>