TAtavus
PALs

Patch PAL

Changed on

Update specific fields of a PAL using JSON Patch operations.

patch/v2/pals/{pal_id}

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/pals/{pal_id}
  • Auth
    API key in header x-api-key

Query parameters

forceboolean

Only relevant when the PAL has unapplied changes in PAL Maker, which makes a normal patch return 409 with "conflict": "maker_changes". Pass force=true to update the live PAL anyway and discard those Maker changes. The response then includes discarded_maker_changes: true.

Request body

op'add' | 'remove' | 'replace' | 'copy' | 'move' | 'test' required

The operation to perform. Must be one of: add, remove, replace, copy, move, test

pathstring required

JSON Pointer (RFC 6901) to a location in the PAL document. Paths must match the current document shape-compare the response from Get PAL (GET /v2/pals/{pal_id}) before patching.

valuestring required

The value to be used within the operation. This field is not required for the remove operation.

Example request

[
  {
    "op": "add",
    "path": "/layers/llm/model",
    "value": "tavus-llama-4"
  }
]

Response

The patched live PAL body.

pal_idstring

The id of the PAL that was updated.

discarded_maker_changesboolean

Present and true only when the request passed force=true and pending PAL Maker changes were discarded to apply this patch. Absent otherwise.

Example response

{
  "pal_id": "pcb7a34da5fe",
  "discarded_maker_changes": true
}

Changes

  • 932c24e63be2Revision changes
    • warning

      deleted the query request parameter target

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter force

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status