VAvapiai
Files

List Files

Changed on
get/file

Request

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

Query parameters

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

Only return files with this purpose. When omitted, files of every purpose except composer attachments are returned.

Response

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

  • ebd122be34f8Revision changes
    • breaking

      the query request parameter purpose was restricted to a list of enum values

    • info

      the query request parameter purpose became optional

    • info

      added the new enum value assistant to the query request parameter purpose

    • info

      added the new enum value composer-attachment to the query request parameter purpose

    • info

      added the new enum value knowledge-base-v2 to the query request parameter purpose

  • 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.