Upload File

POST

https://api.vapi.ai/file

POST

/file

$ curl -X POST https://api.vapi.ai/file \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F file=@JVBERi0xLjQKJcfs...

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "orgId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-01-15T09:30:00Z",
6   "object": "file",
7   "status": "processing",
8   "name": "User_Guide.pdf",
9   "originalName": "User_Guide_2024.pdf",
10   "bytes": 245760,
11   "purpose": "knowledge_base_upload",
12   "mimetype": "application/pdf",
13   "key": "uploads/2024/04/27/user_guide_12345.pdf",
14   "path": "/uploads/2024/04/27/user_guide_12345.pdf",
15   "bucket": "vapi-knowledge-base-files",
16   "url": "https://storage.vapi.ai/vapi-knowledge-base-files/uploads/2024/04/27/user_guide_12345.pdf",
17   "parsedTextUrl": "https://storage.vapi.ai/vapi-knowledge-base-files/parsed_texts/user_guide_12345.txt",
18   "parsedTextBytes": 102400,
19   "metadata": {}
20 }

Uploads a file for use with a Vapi knowledge base.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

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

The object type. This is always file.

statusenum

The current processing status of the uploaded file.

namestring<=40 characters

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

originalNamestring

The original name of the uploaded file.

bytesdouble

The size of the uploaded file in bytes.

purposestring

The intended use assigned to the uploaded file.

mimetypestring

The MIME type of the uploaded file.

keystring

The object-storage key for the uploaded file.

pathstring

The object-storage path for the uploaded file.

bucketstring

The object-storage bucket containing the uploaded file.

urlstring

The URL used to access the uploaded file.

parsedTextUrlstring

The URL used to access text extracted from the file.

parsedTextBytesdouble

The size of the extracted text in bytes.

metadataobject

Additional metadata associated with the uploaded file.

Errors

400

Bad Request Error