API Reference

BulkUpdate

post
https://api.us-east-1.relevance.ai/latest/datasets//documents/bulk_update

Edits documents by providing a key value pair of fields you are adding or changing, make sure to include the "_id" in the documents.

If updating many items in a short timespan, please use BulkUpdate. 

Every update api call temporarily locks and updates the schema, so will slow down with many updates in quick succession.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 240

ID of dataset

Body Params
updates
array of objects
required

List of updates to apply to documents. Each update item must contain an _id.

updates*
boolean
Defaults to true

Whether to include insert date as a field 'insertdate'.

boolean
Defaults to true

Whether to return before all documents have finished updating.

field_transformers
array of objects

Before insertion, fields of documents will be transformed according to this array of rules. If transformation fails, the output field will not be generated.

field_transformers
Response

Updated over 4 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 4 years ago