Upload File

POST

https://api.vapi.ai/file

POST

/file

1 curl -X POST https://api.vapi.ai/file \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: multipart/form-data" \
4      -F file=@base64-encoded-pdf-content

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "orgId": "a12b34c5-d678-90ef-1234-56789abcdef0",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-01-15T09:30:00Z",
6   "object": "file",
7   "status": "processing",
8   "name": "ProjectProposal.pdf",
9   "originalName": "ProjectProposal_2024.pdf",
10   "bytes": 245760,
11   "purpose": "knowledge_base_upload",
12   "mimetype": "application/pdf",
13   "key": "files/2024/04/27/projectproposal_2024.pdf",
14   "path": "/files/2024/04/27/projectproposal_2024.pdf",
15   "bucket": "vapi-uploads",
16   "url": "https://cdn.vapi.ai/files/2024/04/27/projectproposal_2024.pdf",
17   "parsedTextUrl": "https://cdn.vapi.ai/files/2024/04/27/projectproposal_2024.txt",
18   "parsedTextBytes": 10240,
19   "metadata": {}
20 }

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

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

Response

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.

objectenum

Allowed values:

statusenum

Allowed values:

namestring<=40 characters

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

originalNamestring

bytesdouble

purposestring

mimetypestring

keystring

pathstring

bucketstring

urlstring

parsedTextUrlstring

parsedTextBytesdouble

metadataobject

Errors

400

Bad Request Error