---
title: "Capture Exception Api"
method: POST
path: "/api/capture/exception"
---

# Capture Exception Api

`POST /api/capture/exception`

## Request body

- ExceptionCapturePayload
  - `id` string, nullable
  - `timestamp` string, date-time, nullable
  - `app` string
  - `session` string
  - `hierarchy` EventHierarchyInput — Runtime correlation and grouping context captured with one event.
    - `runtime` RuntimeCorrelation — Runtime identity owned or referenced by one captured event.
      - `trace_id` string, required
      - `span_id` string, required
      - `parent_span_id` string, nullable
      - `role` 'operation' | 'annotation', required
      - `origin` 'smello' | 'otel'
    - `group_memberships` union[]
      - union
        - PytestGroupMembership — Position in pytest's collection hierarchy.
          - `kind` 'pytest'
          - `test_directory` GroupReference — Stable group identity and its display label.
            - `id` string, required
            - `label` string, required
          - `test_file` GroupReference, required — Stable group identity and its display label.
            - `id` string, required
            - `label` string, required
          - `test_class` GroupReference — Stable group identity and its display label.
            - `id` string, required
            - `label` string, required
          - `test_case` GroupReference, required — Stable group identity and its display label.
            - `id` string, required
            - `label` string, required
        - HttpRequestGroupMembership — Position in the outgoing HTTP target hierarchy.
          - `kind` 'http_request'
          - `hostname` GroupReference, required — Stable group identity and its display label.
            - `id` string, required
            - `label` string, required
  - `data` ExceptionData, required
    - `exc_type` string, required
    - `exc_value` string
    - `exc_module` string, nullable
    - `traceback_text` string
    - `frames` ExceptionFrame[]
      - `filename` string, required
      - `lineno` integer, nullable
      - `function` string, nullable
      - `context_line` string, nullable
      - `pre_context` string[]
      - `post_context` string[]

## Response `201`

Successful Response

- CaptureResponse
  - `status` string, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-04** `71ae1afbca8d` — 1 info
  - added the new optional request property `hierarchy`
- **2026-05-26** `8389ab2610fc` — 2 info
  - added the new optional request property `app`
  - added the new optional request property `session`
- **2026-05-04** `5561c57fbffd` — 2 warning
  - removed the request property `app`
  - removed the request property `session`

[Change history](https://skmtc.dev/smelloscope/apis/smello/changes/api/capture/exception/post.md)

---

[API](https://skmtc.dev/smelloscope/apis/smello.md) · [All operations](https://skmtc.dev/smelloscope/apis/smello/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smelloscope/smello/revisions/469b056c3641/schema)
