Upload File

This endpoint expects a multipart form containing a file.

filefileRequired

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

File uploaded successfully

idstring

This is the unique identifier for the file.

orgIdstring

This is the unique identifier for the org that this file belongs to.

createdAtdatetime

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

updatedAtdatetime

This is the ISO 8601 date-time string of when the file was last updated.

object"file"OptionalDefaults to file

statusenumOptional

Allowed values:

namestringOptional<=40 characters

This is the name of the file. This is just for your own reference.

originalNamestringOptional

bytesdoubleOptional

purposestringOptional

mimetypestringOptional

keystringOptional

pathstringOptional

bucketstringOptional

urlstringOptional

parsedTextUrlstringOptional

parsedTextBytesdoubleOptional

metadatamap from strings to anyOptional

1	{
2	"id": "id",
3	"orgId": "orgId",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"object": "file",
7	"status": "processing",
8	"name": "name",
9	"originalName": "originalName",
10	"bytes": 1.1,
11	"purpose": "purpose",
12	"mimetype": "mimetype",
13	"key": "key",
14	"path": "path",
15	"bucket": "bucket",
16	"url": "url",
17	"parsedTextUrl": "parsedTextUrl",
18	"parsedTextBytes": 1.1,
19	"metadata": {
20	"key": "value"
21	}
22	}