Skip to main content
POST
/
kb
/
v1
/
files
Upload File
curl --request POST \
  --url https://api-prod.interactly.ai/kb/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
  "name": "some_file.json",
  "type": "file",
  "teamId": "1f7b1b1b1b1b1b1b1b1b1b1b",
  "createdAt": "2020-10-05T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

multipart/form-data
​
file
file
required

This is the File you want to upload for use with the Knowledge Base.

Response

200 - application/json

File uploaded successfully

​
id
string

This is the unique identifier of the file.

Example:

"5f7b1b1b1b1b1b1b1b1b1b1b"

​
name
string

This is the name of the file.

Example:

"some_file.json"

​
type
string
Example:

"file"

​
teamId
string
Example:

"1f7b1b1b1b1b1b1b1b1b1b1b"

​
createdAt
string<date-time>

This is the ISO 8601 date-time string of when the record was created.

Example:

"2020-10-05T00:00:00.000Z"