bulk-exports

Get Bulk Export

Changed on

Get a single bulk export by ID

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

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/bulk-exports/{bulk_export_id}
  • 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

Response

Successful Response

bulk_export_destination_idstring uuid required
session_idstring uuid nullable
all_experimentsboolean
start_timestring date-time required
end_timestring date-time nullable
filterstring nullable
format'Parquet'
format_version'v1' | 'v2_beta'

Enum for bulk export format versions.

compression'none' | 'gzip' | 'snappy' | 'zstandard'
is_rollup_disabledboolean
interval_hoursinteger nullable
export_fieldsstring[] nullable
idstring uuid required
tenant_idstring uuid required
status'Cancelled' | 'Completed' | 'Created' | 'IntervalScheduled' | 'Failed' | 'TimedOut' | 'Running' required
created_atstring date-time required
updated_atstring date-time required
finished_atstring date-time nullable required
source_bulk_export_idstring uuid 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 optional property to the response with the status

    • info

      the response's property default value changed from gzip to zstandard for the status

  • a0acb3a6a101Revision changes
    • breaking

      the response property became optional for the status

    • breaking

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

    • info

      added the optional property to the response with the status