VAvapiai
Files

Upload File

Changed on
post/file

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Request body multipart/form-data

filestring binary required

The file to upload.

purpose'assistant' | 'composer-attachment' | 'knowledge-base-v2'

Optional product flow that owns the uploaded file.

metadatastring

Optional JSON-encoded metadata for multipart uploads.

Response

File uploaded successfully

object'file'
status'processing' | 'done' | 'failed'
namestring

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

originalNamestring
bytesnumber
purposestring
mimetypestring
keystring
pathstring
bucketstring
urlstring
parsedTextUrlstring
parsedTextBytesnumber
metadataobject
idstring required

This is the unique identifier for the file.

orgIdstring required

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

createdAtstring date-time required

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

updatedAtstring date-time required

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

Changes

  • 9e98d32ea541Revision changes
    • warning

      added the new done enum value to the response property for the response status

    • warning

      added the new failed enum value to the response property for the response status

    • warning

      added the new processing enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the indexed enum value from the response property for the response status

    • info

      removed the not_indexed enum value from the response property for the response status

Some revisions have not been checked yet.