examples

Update Example

Changed on

Update a specific example.

patch/api/v1/examples/{example_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/examples/{example_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

example_idstring uuid required

Request body

dataset_idstring uuid nullable

The example's current dataset. An example can't move to another dataset.

inputsobject nullable

New inputs. Replaces the existing inputs; omit to keep them.

outputsobject nullable

New outputs. Replaces the existing outputs; omit to keep them.

metadataobject nullable

New metadata. Replaces the existing metadata; omit to keep it.

overwriteboolean

Not used.

Response

Successful Response

unknown required

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status