Skip to main content
POST
/
agent-setup
/
upload
Upload context files during agent setup
curl --request POST \
  --url https://api.beamstudio.ai/agent-setup/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>' \
  --form threadId=1a2036c0-d533-4636-8f51-2a811763ef5c \
  --form 'files=<string>' \
  --form files.items='@example-file'
[
  {
    "name": "<string>",
    "threadId": "<string>",
    "uploadStatus": "processing",
    "uploadSource": "file_upload",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "src": "<string>",
    "fileKey": "<string>",
    "url": "<string>",
    "mimeType": "<string>",
    "userId": "<string>",
    "user": {
      "name": "string",
      "email": "string",
      "cognitoUserId": "string",
      "role_name": "string",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "avatarSrc": "string",
      "socialProvider": "string",
      "socialProviderId": "string",
      "emailVerified": true,
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "deletedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

Headers

​
current-workspace-id
string
required

Body

multipart/form-data

Files to upload with thread ID

​
threadId
string<uuid>
required

UUID of the conversation thread

Example:

"1a2036c0-d533-4636-8f51-2a811763ef5c"

​
files
file[]
required

Array of files to upload (maximum 10 files)

Response

201 - application/json
​
name
string
required
​
threadId
string
required
​
uploadStatus
enum<string>
required
Available options:
processing,
uploaded,
failed
​
uploadSource
enum<string>
required
Available options:
file_upload,
text_snippet,
url_upload
​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
src
string
​
fileKey
string
​
url
string
​
mimeType
string
​
userId
string
​
user
object
​
deletedAt
string<date-time>