Upload a file

Files are used to upload documents that can be used with features like Deployments.

POST /v2/files

Upload a file

cURL

curl --request POST \
  --url https://api.orq.ai/v2/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "<string>",
  "content": "<string>",
  "purpose": 123,
  "content_type": "<string>"
}
'

200

{
  "file": {
    "file_id": "<string>",
    "purpose": 123,
    "file_name": "<string>",
    "workspace_id": "<string>",
    "bytes": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

filename · string

content · string<bytes>

purpose · integer<enum>

content_type · string

Response

200 - application/json

OK

file · object

Show child attributes