Create a direct upload session for a thread attachment. - RevoEngine

POST

/

api

/

v1

/

chat

/

threads

/

{threadId}

/

uploads

Create a direct upload session for a thread attachment.

curl --request POST \
  --url https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "retention": {
    "ttlSeconds": 2,
    "expiresAt": "2026-08-01T12:00:00.000Z"
  },
  "name": "contract.pdf",
  "contentTypeHint": "application/pdf",
  "sizeHint": 1048576,
  "chatMessageId": "<string>",
  "clientDraftId": "<string>",
  "metadata": {
    "source": "chat-composer"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    retention: {ttlSeconds: 2, expiresAt: '2026-08-01T12:00:00.000Z'},
    name: 'contract.pdf',
    contentTypeHint: 'application/pdf',
    sizeHint: 1048576,
    chatMessageId: '<string>',
    clientDraftId: '<string>',
    metadata: {source: 'chat-composer'}
  })
};

fetch('https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads"

payload = {
    "retention": {
        "ttlSeconds": 2,
        "expiresAt": "2026-08-01T12:00:00.000Z"
    },
    "name": "contract.pdf",
    "contentTypeHint": "application/pdf",
    "sizeHint": 1048576,
    "chatMessageId": "<string>",
    "clientDraftId": "<string>",
    "metadata": { "source": "chat-composer" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Path Parameters

threadId

string

required

Body

application/json

retention

object | null

Attachment file retention. Omit for no expiration, null for explicitly durable, or provide ttlSeconds/expiresAt.

Show child attributes

name

string

File name. Required for create mode.

Example:

"contract.pdf"

contentTypeHint

string

Expected content type.

Example:

"application/pdf"

sizeHint

number

Expected size in bytes.

Required range: x >= 0

Example:

1048576

chatMessageId

string

Optional message id when attaching to an existing chat message.

clientDraftId

string

Optional client draft id used to correlate uploads in the composer. Send the returned attachment.storageUploadSessionId on message creation.

Maximum string length: 128

metadata

object | null

File metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:

{ "source": "chat-composer" }

Response

200

OK.

Create a direct upload session for a thread attachment.

curl --request POST \
  --url https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "retention": {
    "ttlSeconds": 2,
    "expiresAt": "2026-08-01T12:00:00.000Z"
  },
  "name": "contract.pdf",
  "contentTypeHint": "application/pdf",
  "sizeHint": 1048576,
  "chatMessageId": "<string>",
  "clientDraftId": "<string>",
  "metadata": {
    "source": "chat-composer"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    retention: {ttlSeconds: 2, expiresAt: '2026-08-01T12:00:00.000Z'},
    name: 'contract.pdf',
    contentTypeHint: 'application/pdf',
    sizeHint: 1048576,
    chatMessageId: '<string>',
    clientDraftId: '<string>',
    metadata: {source: 'chat-composer'}
  })
};

fetch('https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/chat/threads/{threadId}/uploads"

payload = {
    "retention": {
        "ttlSeconds": 2,
        "expiresAt": "2026-08-01T12:00:00.000Z"
    },
    "name": "contract.pdf",
    "contentTypeHint": "application/pdf",
    "sizeHint": 1048576,
    "chatMessageId": "<string>",
    "clientDraftId": "<string>",
    "metadata": { "source": "chat-composer" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)