> ## 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.

# Register schema

> Registers a new org-native event subtype.

```python theme={null}
olira.register_schema(
    subtype: str,
    description: str = "",
    input_examples: list[dict] | None = None,
    schema: dict | None = None,
    mapping: dict | None = None,
) -> SchemaRegistrationResult
```

**Requires scope:** `api:org-config`

Pass both schema and mapping for a "full\_spec" submission (e.g. your own agent already authored them); pass neither/either for an "assisted" submission Olira will author from your input\_examples + description. Always lands as a pending request — Olira reviews and materializes it before it can be activated.

## Parameters

<ParamField body="subtype" type="str" required>
  New org-defined source event subtype, e.g. `rc_conversation_completed` (lowercase snake\_case, 3–64 chars).
</ParamField>

<ParamField body="description" type="str" default="&#x22;&#x22;">
  What this source event represents.
</ParamField>

<ParamField body="input_examples" type="list[dict] | None" default="None">
  Sample raw payloads (capped at 20).
</ParamField>

<ParamField body="schema" type="dict | None" default="None">
  Full JSON Schema for the payload, if already authored (e.g. by your agent).
</ParamField>

<ParamField body="mapping" type="dict | None" default="None">
  Full mapping spec (source\_root/targets/unmapped\_fields\_policy), if already authored.
</ParamField>

## Returns

`SchemaRegistrationResult`

<ResponseField name="registration_id" type="str">
  Id of the created registration.
</ResponseField>

<ResponseField name="subtype" type="str">
  The registered subtype.
</ResponseField>

<ResponseField name="target_version" type="int">
  Version this registration is proposing (1 for a new subtype).
</ResponseField>

<ResponseField name="submission_mode" type="str">
  "full\_spec" if both schema and mapping were provided, else "assisted".
</ResponseField>

<ResponseField name="status" type="str">
  "pending\_review" — registrations never auto-activate.
</ResponseField>

<ResponseField name="self_check" type="dict | None">
  Dry-run result against input\_examples; populated only for full\_spec submissions.
</ResponseField>

## Raises

| Exception         | When                                                                                                                  |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `AuthError`       | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.                                      |
| `ValidationError` | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).   |
| `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

  olira.init(api_key="YOUR_API_KEY")
  registration = olira.register_schema(
      subtype="widget_ping",
      description="Widget sensor ping events",
      input_examples=[{"reading_value": 42, "unit": "lux"}],
  )
  print(registration.status)
  ```

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

  {
    "subtype": "widget_ping",
    "description": "Widget sensor ping events",
    "input_examples": [{"reading_value": 42, "unit": "lux"}]
  }
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  SchemaRegistrationResult(
      registration_id="6a5523da0d094fdeed36f566",
      subtype="widget_ping",
      target_version=1,
      submission_mode="assisted",
      status="pending_review",
      self_check=None,
  )
  ```

  ```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>