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

# Update trace

> Update an existing trace. See [Traces](https://docs.galtea.ai/concepts/product/version/session/trace). The REST path `/inferenceResults` and the `inferenceResult*` JSON fields keep the old name of this entity.

> [!WARNING]
>
> You are reading the docs of Galtea 5.16. [Read this page in the latest version](https://docs.galtea.ai/api-reference/traces/update-trace.md).


## OpenAPI

````yaml /v5.16/openapi.json patch /inferenceResults/{id}
openapi: 3.0.0
info:
  version: 1.0.0
  title: Product Management Service API
  description: API documentation for Product Management Service
  contact:
    name: Galtea AI
servers:
  - url: https://api.galtea.ai
security:
  - bearerAuth: []
tags: []
externalDocs:
  description: Galtea Platform Documentation
  url: https://docs.galtea.ai
paths:
  /inferenceResults/{id}:
    patch:
      tags:
        - traces
      summary: Update trace
      description: >-
        Update an existing trace. See
        [Traces](https://docs.galtea.ai/concepts/product/version/session/trace).
        The REST path `/inferenceResults` and the `inferenceResult*` JSON fields
        keep the old name of this entity.
      operationId: updateInferenceResult
      parameters:
        - name: id
          in: path
          description: Trace ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                actualOutput:
                  oneOf:
                    - type: string
                    - type: object
                  nullable: true
                  description: >-
                    Agent output. Plain text by default (the scored scalar); an
                    envelope { assistant_message, content: [{ type, uri,
                    transcript }] } carries audio or file parts. A file part
                    with a non-empty uri is a file, and an answer that is only
                    files needs no scalar. A file element with no uri belongs to
                    the customer: it is stored as sent beside a scalar, and
                    refused without one.
                  example: Model response text
                retrievalContext:
                  type: string
                  example: Retrieved context document
                error:
                  type: string
                  nullable: true
                  description: >-
                    Error message explaining why this trace failed or was
                    skipped
                latency:
                  type: number
                  description: Latency in milliseconds
                input:
                  oneOf:
                    - type: string
                    - type: object
                  nullable: true
                  description: >-
                    Agent input for this turn. Plain text by default; for voice,
                    an envelope carrying audio content parts. Each element of a
                    `content` array is read on its own. A file part is a Galtea
                    file when its uri names a Galtea storage key
                    (`files/<organization>/<32 hex>.<extension>`, on any host):
                    it is stored signature-free and checked as on a test case
                    input (at most 20 files and 20 MB, an accepted file type, a
                    file of this organization), otherwise 400. A Galtea file
                    missing from storage is stored signature-free without its
                    sizeBytes, and every other element as sent.
                status:
                  type: string
                  enum:
                    - PENDING
                    - GENERATED
                    - FAILED
                    - SKIPPED
                  description: >-
                    Trace lifecycle status. Becomes GENERATED automatically when
                    actualOutput is written and no status is given.
                inputTokens:
                  type: integer
                  description: >-
                    Input tokens sent to the model. Recounted from the input
                    when the request carries an input and omits this, unless the
                    row keeps its cost (see `cost`). At most 2147483647, else
                    400.
                outputTokens:
                  type: integer
                  description: >-
                    Output tokens generated by the model. Recounted from the
                    output when the request carries an output and omits this,
                    unless the row keeps its cost (see `cost`) or is a PENDING
                    turn that already holds a reported count and has no output
                    yet. At most 2147483647, else 400.
                cacheReadInputTokens:
                  type: integer
                  description: >-
                    Input tokens read from the model cache. At most 2147483647,
                    else 400.
                tokens:
                  type: integer
                  description: >-
                    Total tokens. A value you send here is stored as sent.
                    Omitted, it is re-derived from the three counts above when
                    the request sends an input, an output, a count, a rate or
                    the cost, unless the row keeps its cost (see `cost`). At
                    most 2147483647, else 400.
                cost:
                  type: number
                  description: >-
                    Total cost. A value you send here is stored as sent.
                    Omitted, it is re-derived from the token counts and the
                    per-token rates when the request sends a count or a rate. A
                    request that sends an input or an output and no count or
                    rate re-derives it at the stored rates, but keeps a cost
                    those counts and rates do not produce, such as a stated cost
                    or a cost summed over spans on several models. A request
                    that sends only `tokens` keeps the cost.
                costPerInputToken:
                  type: number
                  description: >-
                    Price of one input token. Replaced by the span rates when
                    the turn's spans report usage; null when they use different
                    rates. A `cost` you state is kept.
                costPerOutputToken:
                  type: number
                  description: >-
                    Price of one output token. Replaced by the span rates when
                    the turn's spans report usage; null when they use different
                    rates. A `cost` you state is kept.
                costPerCacheReadInputToken:
                  type: number
                  description: >-
                    Price of one cache-read token. Replaced by the span rates
                    when the turn's spans report usage; null when they use
                    different rates. A `cost` you state is kept.
                conversationSimulatorVersion:
                  type: string
                  nullable: true
                  description: >-
                    Version of Galtea's conversation simulator that produced the
                    user message
      responses:
        '200':
          description: Trace updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceResult'
        '400':
          description: >-
            Invalid body, including a Galtea file on the input or output that
            breaks a file rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Trace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    InferenceResult:
      type: object
      description: >-
        A trace: one conversation turn, holding the input and the agent output.
        The schema name, the `/inferenceResults` path and every
        `inferenceResult*` field still carry the old name of this entity,
        "inference result". Only the wording changed so far; the wire contract
        is renamed in a later API release.
      properties:
        id:
          type: string
          example: ir_123
        sessionId:
          type: string
          example: session_123
        userId:
          type: string
          nullable: true
          example: user_123
        index:
          type: integer
          example: 0
          description: Order index within the session
        status:
          type: string
          enum:
            - PENDING
            - GENERATED
            - FAILED
            - SKIPPED
          example: PENDING
        error:
          type: string
          nullable: true
          description: Error message explaining why this trace failed or was skipped
          example: null
        input:
          type: object
          nullable: true
          description: >-
            Structured input data. For plain text input, format is {
            user_message: "..." }. A `content` array of parts (audio or file)
            can sit beside an optional `user_message`. Each element of a
            `content` array is read on its own. A file part is a Galtea file
            when its uri names a Galtea storage key (`files/<organization>/<32
            hex>.<extension>`, on any host): it is stored signature-free and
            checked as on a test case input (at most 20 files and 20 MB, an
            accepted file type, a file of this organization), otherwise 400. A
            Galtea file missing from storage is stored signature-free without
            its sizeBytes, and every other element as sent. A metric scores a
            Galtea file only when its judge model reads that kind of file (PNG,
            JPEG, WebP, GIF or PDF); any other metric that reads this side is
            skipped, except a human evaluation or self-hosted one, and the
            reason names the file.
          example:
            user_message: User input text
        actualOutput:
          oneOf:
            - type: string
            - type: object
          nullable: true
          description: >-
            The agent turn output. Plain text by default (the scored scalar). An
            envelope { assistant_message, content: [...] } carries a `content`
            array of parts (audio or file) beside an optional
            `assistant_message` — the scored scalar stays the canonical
            transcript, and an answer that is only a file carries no scalar at
            all. A metric scores a Galtea file only when its judge model reads
            that kind of file (PNG, JPEG, WebP, GIF or PDF); any other metric
            that reads this side is skipped, except a human evaluation or
            self-hosted one, and the reason names the file.
          example: Model response
        latency:
          type: integer
          nullable: true
          example: 150
        inputTokens:
          type: integer
          nullable: true
          example: 100
        outputTokens:
          type: integer
          nullable: true
          example: 50
        cacheReadInputTokens:
          type: integer
          nullable: true
          example: 20
        tokens:
          type: integer
          nullable: true
          example: 150
          description: Total tokens
        costPerInputToken:
          type: number
          nullable: true
          example: 0.00001
        costPerOutputToken:
          type: number
          nullable: true
          example: 0.00003
        costPerCacheReadInputToken:
          type: number
          nullable: true
          example: 0.000005
        cost:
          type: number
          nullable: true
          example: 0.001
        creditsUsed:
          type: integer
          nullable: true
          example: 1
        droppedSpanCount:
          type: integer
          nullable: true
          example: 2
          description: >-
            How many spans sent with this trace were refused, for example a span
            with an empty name or a negative latency. Null means none were
            refused.
        conversationSimulatorVersion:
          type: string
          nullable: true
          example: 1.0.0
        traceId:
          type: string
          nullable: true
          example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
          description: >-
            W3C trace ID Galtea sends in the `traceparent` header on this Direct
            Inference turn. Stored when the turn starts. This is the
            OpenTelemetry trace id, not the id of this Galtea trace, which is
            `id`.
        createdAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
          nullable: true
        comments:
          type: array
          description: Free-form reviewer annotations on this turn, oldest first.
          items:
            $ref: '#/components/schemas/Comment'
    Error:
      type: object
      properties:
        error:
          type: string
          example: Error type
        message:
          type: string
          example: Error message description
    Comment:
      type: object
      properties:
        id:
          type: string
          example: comment_123
        inferenceResultId:
          type: string
          example: inferenceResult_123
        text:
          type: string
          example: Agent hallucinated the price.
        tags:
          type: array
          items:
            type: string
          example:
            - hallucination
            - tone
        userId:
          type: string
          nullable: true
          example: user_123
        userName:
          type: string
          nullable: true
          example: John Doe
        userEmail:
          type: string
          nullable: true
          format: email
          example: user@example.com
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - inferenceResultId
        - text
        - tags
        - userId
        - userName
        - userEmail
        - createdAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authorization. Pass your API key in the Authorization header as
        a Bearer token. Both new (`gsk_*`) and legacy (`gsk-`) API keys are
        accepted, e.g. `Authorization: Bearer gsk_...` or `Authorization: Bearer
        gsk-...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.