---
title: "Patch Observability"
method: PATCH
path: "/admin/api/v1/observability"
tags: ["Observability"]
---

# Patch Observability

`PATCH /admin/api/v1/observability`

Upsert the singleton observability row.

First write requires ``observability``. Updates apply only the
fields explicitly present in the body. The reload pipeline
reassembles + validates the engine config; failures roll back
with a 422.

## Request body

- StandaloneObservabilityPatch — Body for PATCH /admin/api/v1/observability. All fields optional.
  - `observability` ObservabilityConfigInput — Observability configuration.
    - `provider` 'LANGFUSE' | 'PHOENIX' | 'GCP_LOGGING' | 'GCP_TRACE' | 'LANGSMITH' — Supported observability providers.
    - `enabled` boolean
    - `config` union, required
      - LangfuseConfig — Langfuse configuration.
        - `provider` 'LANGFUSE'
        - `host` string
        - `publicKey` string
        - `secretKey` string
        - `runName` string
      - PhoenixConfig — Phoenix configuration.
        - `provider` 'PHOENIX'
        - `collectorEndpoint` string
        - `projectName` string
      - GCPLoggingConfig — GCP Logging configuration.
        - `provider` 'GCP_LOGGING'
        - `gcpProjectId` string — The project identifier where logs and traces will be sent.
        - `region` string — (Optional) The specific region/zone associated with the resource (e.g., us-central1).
        - `logName` string — The identifier for the log stream (e.g., application-log).
        - `resourceType` string — The resource type label (e.g., global, gce_instance, cloud_run_revision).
        - `severity` string — Minimum level to record (e.g., INFO, WARNING, ERROR, CRITICAL).
        - `transport` string — Selection for delivery method (e.g., BackgroundThread vs Synchronous).
      - GCPTraceConfig — GCP Trace configuration.
        - `provider` 'GCP_TRACE'
        - `gcpProjectId` string — The project identifier where logs and traces will be sent.
        - `region` string — (Optional) The specific region/zone associated with the resource (e.g., us-central1).
        - `traceName` string — The name for the trace or tracing session.
        - `samplingRate` number — A number between 0.0 and 1.0 indicating the probability of a request being traced (e.g., 1.0 for 100%, 0.1 for 10%).
        - `flushInterval` integer — Time in seconds to wait before sending buffered traces to the cloud.
        - `ignoreUrls` string — A list or comma-separated string of URL paths to exclude from tracing (e.g., /health, /metrics).
      - LangsmithConfig — Langsmith configuration.
        - `provider` 'LANGSMITH'
        - `apiKey` string — The unique authentication key from the LangSmith settings page.
        - `projectName` string — The name of the project in LangSmith to bucket these traces under (e.g., prod-chatbot-v1).
        - `endpoint` string — The URL endpoint, used primarily if you are self-hosting LangSmith or using a specific enterprise instance. (e.g., https://api.smith.langchain.com)
        - `runName` string — The display name for each trace run in LangSmith (e.g., my-agent).

## Response `200`

Successful Response

- StandaloneMutationResponseStandaloneObservabilityRead
  - `data` StandaloneObservabilityRead, required — GET response and the data payload of PATCH responses.
    - `observability` IdunAgentSchemaEngineObservabilityV2ObservabilityConfig, required — Observability configuration.
      - `provider` 'LANGFUSE' | 'PHOENIX' | 'GCP_LOGGING' | 'GCP_TRACE' | 'LANGSMITH' — Supported observability providers.
      - `enabled` boolean
      - `config` union, required
        - LangfuseConfig — Langfuse configuration.
          - `provider` 'LANGFUSE'
          - `host` string
          - `publicKey` string
          - `secretKey` string
          - `runName` string
        - PhoenixConfig — Phoenix configuration.
          - `provider` 'PHOENIX'
          - `collectorEndpoint` string
          - `projectName` string
        - GCPLoggingConfig — GCP Logging configuration.
          - `provider` 'GCP_LOGGING'
          - `gcpProjectId` string — The project identifier where logs and traces will be sent.
          - `region` string — (Optional) The specific region/zone associated with the resource (e.g., us-central1).
          - `logName` string — The identifier for the log stream (e.g., application-log).
          - `resourceType` string — The resource type label (e.g., global, gce_instance, cloud_run_revision).
          - `severity` string — Minimum level to record (e.g., INFO, WARNING, ERROR, CRITICAL).
          - `transport` string — Selection for delivery method (e.g., BackgroundThread vs Synchronous).
        - GCPTraceConfig — GCP Trace configuration.
          - `provider` 'GCP_TRACE'
          - `gcpProjectId` string — The project identifier where logs and traces will be sent.
          - `region` string — (Optional) The specific region/zone associated with the resource (e.g., us-central1).
          - `traceName` string — The name for the trace or tracing session.
          - `samplingRate` number — A number between 0.0 and 1.0 indicating the probability of a request being traced (e.g., 1.0 for 100%, 0.1 for 10%).
          - `flushInterval` integer — Time in seconds to wait before sending buffered traces to the cloud.
          - `ignoreUrls` string — A list or comma-separated string of URL paths to exclude from tracing (e.g., /health, /metrics).
        - LangsmithConfig — Langsmith configuration.
          - `provider` 'LANGSMITH'
          - `apiKey` string — The unique authentication key from the LangSmith settings page.
          - `projectName` string — The name of the project in LangSmith to bucket these traces under (e.g., prod-chatbot-v1).
          - `endpoint` string — The URL endpoint, used primarily if you are self-hosting LangSmith or using a specific enterprise instance. (e.g., https://api.smith.langchain.com)
          - `runName` string — The display name for each trace run in LangSmith (e.g., my-agent).
    - `updatedAt` string, date-time, required
  - `reload` StandaloneReloadResult, required — Reload outcome attached to every admin mutation response. ``reloaded`` means DB committed and runtime now uses the new config. ``restart_required`` means DB committed and process restart is needed. ``reload_failed`` means DB rolled back and runtime is unchanged.
    - `status` 'reloaded' | 'restart_required' | 'reload_failed', required — Outcome of a reload triggered by an admin mutation.
    - `message` string, required
    - `error` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/idun-group/apis/idun-agent-engine-server.md) · [All operations](https://skmtc.net/idun-group/apis/idun-agent-engine-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/idun-group/idun-agent-engine-server/revisions/8909cd73cc1c/schema)