run

Delete Runs

Changed on

DELETE with body payload — removes the runs identified by the request payload.

Delete runs by trace ID, or every run in a time range.

Supply session_id and trace_ids to delete a known list of traces, or metadata with start_time to delete matching traces from that time onward. Add end_time to bound the range; with both bounds set metadata is optional, and omitting it deletes every trace that started in the range.

post/api/v1/runs/delete

Request

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

Request body

session_idstring uuid nullable
trace_idsstring[] nullable
metadataobject nullable
delete_examplesboolean
start_timestring date-time nullable
end_timestring date-time nullable

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

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • a0acb3a6a101Revision changes
    • info

      added the new optional request property

    • info

      request body became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json