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

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



## OpenAPI

````yaml /standalone/openapi.json patch /admin/api/v1/observability
openapi: 3.1.0
info:
  title: Idun Agent Engine Server
  description: A production-ready server for conversational AI agents
  version: 0.6.1
servers: []
security: []
tags:
  - name: Runtime
    description: >-
      Public agent run endpoints, engine operations, and chat-channel webhooks.
      SSE streaming via the AG-UI protocol.
  - name: Agent Configuration
    description: >-
      Singleton admin endpoints for the agent, prompts, memory, guardrails, and
      onboarding wizard.
  - name: Auth & SSO
    description: >-
      Login, sessions, password change, SSO config, and the public SSO discovery
      endpoint.
  - name: Integrations & Tools
    description: MCP server registry and external integration credentials.
  - name: Observability
    description: Tracing/logging provider configuration.
  - name: Traces
    description: >-
      Trace and span storage admin endpoints — list, detail, delete, and
      pipeline-health for the standalone trace store.
  - name: Dashboard
    description: >-
      Operator dashboard widgets — KPIs, time-series, top errors, and
      configuration summary.
paths:
  /admin/api/v1/observability:
    patch:
      tags:
        - Observability
      summary: Patch Observability
      description: |-
        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.
      operationId: patch_observability_admin_api_v1_observability_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandaloneObservabilityPatch'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/StandaloneMutationResponse_StandaloneObservabilityRead_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    StandaloneObservabilityPatch:
      properties:
        observability:
          anyOf:
            - $ref: '#/components/schemas/ObservabilityConfig-Input'
            - type: 'null'
      type: object
      title: StandaloneObservabilityPatch
      description: Body for PATCH /admin/api/v1/observability. All fields optional.
    StandaloneMutationResponse_StandaloneObservabilityRead_:
      properties:
        data:
          $ref: '#/components/schemas/StandaloneObservabilityRead'
        reload:
          $ref: '#/components/schemas/StandaloneReloadResult'
      type: object
      required:
        - data
        - reload
      title: StandaloneMutationResponse[StandaloneObservabilityRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ObservabilityConfig-Input:
      properties:
        provider:
          $ref: '#/components/schemas/ObservabilityProvider'
          default: LANGFUSE
        enabled:
          type: boolean
          title: Enabled
          default: true
        config:
          oneOf:
            - $ref: '#/components/schemas/LangfuseConfig'
            - $ref: '#/components/schemas/PhoenixConfig'
            - $ref: '#/components/schemas/GCPLoggingConfig'
            - $ref: '#/components/schemas/GCPTraceConfig'
            - $ref: '#/components/schemas/LangsmithConfig'
          title: Config
          discriminator:
            propertyName: provider
            mapping:
              GCP_LOGGING:
                $ref: '#/components/schemas/GCPLoggingConfig'
              GCP_TRACE:
                $ref: '#/components/schemas/GCPTraceConfig'
              LANGFUSE:
                $ref: '#/components/schemas/LangfuseConfig'
              LANGSMITH:
                $ref: '#/components/schemas/LangsmithConfig'
              PHOENIX:
                $ref: '#/components/schemas/PhoenixConfig'
      type: object
      required:
        - config
      title: ObservabilityConfig
      description: Observability configuration.
    StandaloneObservabilityRead:
      properties:
        observability:
          $ref: >-
            #/components/schemas/idun_agent_schema__engine__observability_v2__ObservabilityConfig
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
        - observability
        - updatedAt
      title: StandaloneObservabilityRead
      description: GET response and the data payload of PATCH responses.
    StandaloneReloadResult:
      properties:
        status:
          $ref: '#/components/schemas/StandaloneReloadStatus'
        message:
          type: string
          title: Message
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
      type: object
      required:
        - status
        - message
      title: StandaloneReloadResult
      description: |-
        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.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ObservabilityProvider:
      type: string
      enum:
        - LANGFUSE
        - PHOENIX
        - GCP_LOGGING
        - GCP_TRACE
        - LANGSMITH
      title: ObservabilityProvider
      description: Supported observability providers.
    LangfuseConfig:
      properties:
        provider:
          type: string
          const: LANGFUSE
          title: Provider
          default: LANGFUSE
        host:
          type: string
          title: Host
          default: https://cloud.langfuse.com
        publicKey:
          type: string
          title: Publickey
          default: ''
        secretKey:
          type: string
          title: Secretkey
          default: ''
        runName:
          type: string
          title: Runname
          default: ''
      type: object
      title: LangfuseConfig
      description: Langfuse configuration.
    PhoenixConfig:
      properties:
        provider:
          type: string
          const: PHOENIX
          title: Provider
          default: PHOENIX
        collectorEndpoint:
          type: string
          title: Collectorendpoint
          default: https://collector.phoenix.com
        projectName:
          type: string
          title: Projectname
          default: ''
      type: object
      title: PhoenixConfig
      description: Phoenix configuration.
    GCPLoggingConfig:
      properties:
        provider:
          type: string
          const: GCP_LOGGING
          title: Provider
          default: GCP_LOGGING
        gcpProjectId:
          type: string
          title: Gcpprojectid
          description: The project identifier where logs and traces will be sent.
          default: ''
        region:
          type: string
          title: Region
          description: >-
            (Optional) The specific region/zone associated with the resource
            (e.g., us-central1).
          default: ''
        logName:
          type: string
          title: Logname
          description: The identifier for the log stream (e.g., application-log).
          default: ''
        resourceType:
          type: string
          title: Resourcetype
          description: >-
            The resource type label (e.g., global, gce_instance,
            cloud_run_revision).
          default: ''
        severity:
          type: string
          title: Severity
          description: Minimum level to record (e.g., INFO, WARNING, ERROR, CRITICAL).
          default: INFO
        transport:
          type: string
          title: Transport
          description: >-
            Selection for delivery method (e.g., BackgroundThread vs
            Synchronous).
          default: BackgroundThread
      type: object
      title: GCPLoggingConfig
      description: GCP Logging configuration.
    GCPTraceConfig:
      properties:
        provider:
          type: string
          const: GCP_TRACE
          title: Provider
          default: GCP_TRACE
        gcpProjectId:
          type: string
          title: Gcpprojectid
          description: The project identifier where logs and traces will be sent.
          default: ''
        region:
          type: string
          title: Region
          description: >-
            (Optional) The specific region/zone associated with the resource
            (e.g., us-central1).
          default: ''
        traceName:
          type: string
          title: Tracename
          description: The name for the trace or tracing session.
          default: ''
        samplingRate:
          type: number
          maximum: 1
          minimum: 0
          title: Samplingrate
          description: >-
            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%).
          default: 1
        flushInterval:
          type: integer
          minimum: 0
          title: Flushinterval
          description: Time in seconds to wait before sending buffered traces to the cloud.
          default: 5
        ignoreUrls:
          type: string
          title: Ignoreurls
          description: >-
            A list or comma-separated string of URL paths to exclude from
            tracing (e.g., /health, /metrics).
          default: ''
      type: object
      title: GCPTraceConfig
      description: GCP Trace configuration.
    LangsmithConfig:
      properties:
        provider:
          type: string
          const: LANGSMITH
          title: Provider
          default: LANGSMITH
        apiKey:
          type: string
          title: Apikey
          description: The unique authentication key from the LangSmith settings page.
          default: ''
        projectName:
          type: string
          title: Projectname
          description: >-
            The name of the project in LangSmith to bucket these traces under
            (e.g., prod-chatbot-v1).
          default: ''
        endpoint:
          type: string
          title: Endpoint
          description: >-
            The URL endpoint, used primarily if you are self-hosting LangSmith
            or using a specific enterprise instance. (e.g.,
            https://api.smith.langchain.com)
          default: ''
        runName:
          type: string
          title: Runname
          description: The display name for each trace run in LangSmith (e.g., my-agent).
          default: ''
      type: object
      title: LangsmithConfig
      description: Langsmith configuration.
    idun_agent_schema__engine__observability_v2__ObservabilityConfig:
      properties:
        provider:
          $ref: '#/components/schemas/ObservabilityProvider'
          default: LANGFUSE
        enabled:
          type: boolean
          title: Enabled
          default: true
        config:
          oneOf:
            - $ref: '#/components/schemas/LangfuseConfig'
            - $ref: '#/components/schemas/PhoenixConfig'
            - $ref: '#/components/schemas/GCPLoggingConfig'
            - $ref: '#/components/schemas/GCPTraceConfig'
            - $ref: '#/components/schemas/LangsmithConfig'
          title: Config
          discriminator:
            propertyName: provider
            mapping:
              GCP_LOGGING:
                $ref: '#/components/schemas/GCPLoggingConfig'
              GCP_TRACE:
                $ref: '#/components/schemas/GCPTraceConfig'
              LANGFUSE:
                $ref: '#/components/schemas/LangfuseConfig'
              LANGSMITH:
                $ref: '#/components/schemas/LangsmithConfig'
              PHOENIX:
                $ref: '#/components/schemas/PhoenixConfig'
      type: object
      required:
        - config
      title: ObservabilityConfig
      description: Observability configuration.
    StandaloneReloadStatus:
      type: string
      enum:
        - reloaded
        - restart_required
        - reload_failed
      title: StandaloneReloadStatus
      description: Outcome of a reload triggered by an admin mutation.

````