Skip to main content
POST
/
documents
/
Upload document(s)
curl --request POST \
  --url http:localhost:3000/v2/documents/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-API-Key: <api-key>' \
  --form 'name=<string>' \
  --form 'objectId=<string>' \
  --form 'userId=<string>' \
  --form 'jobId=<string>' \
  --form 'customerId=<string>' \
  --form file=@example-file
{
  "_id": "<string>",
  "ids": [
    "<string>"
  ]
}

Authorizations

x-API-Key
string
header
required

Body

multipart/form-data

Document file(s) and optional metadata

file
file
required

File to upload

name
string
required

Document name (optional)

objectId
string<objectid>

Related object ID (optional)

userId
string<objectid>

Related user ID (optional)

jobId
string<objectid>

Related job ID (optional)

customerId
string<objectid>

Related customer ID (optional)

Response

Document(s) uploaded successfully

_id
string<objectid>
ids
string<objectid>[]