bulk-exports

Get Bulk Export Runs

Changed on

Get a bulk export's runs

get/api/v1/bulk-exports/{bulk_export_id}/runs

Request

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

Path parameters

bulk_export_idstring uuid required

Query parameters

limitinteger nullable
offsetinteger

Response

Successful Response

bulk_export_idstring uuid required
session_idstring uuid nullable
idstring uuid required
status'Cancelled' | 'Completed' | 'Created' | 'Failed' | 'TimedOut' | 'Running' required
retry_numberinteger
errorsobject nullable
created_atstring date-time required
updated_atstring date-time required
finished_atstring date-time nullable required
start_timestring date-time nullable
end_timestring date-time nullable

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 query request parameter limit

    • info

      added the new optional query request parameter offset

  • a0acb3a6a101Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status