Skip to main content
POST
/
documents
Generate upload URL
curl --request POST \
  --url https://api.example.com/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "test": true
}
'
{
  "url": "<string>",
  "id": "<string>"
}

Body

application/json
metadata
object[]
required

metadata assigned to the object

name
string
required

the name of the document

test
boolean

is it a test customer

Response

200 - application/json
url
string
required

the signed url to upload the document

id
string
required

the id of the document