Files
patch/file/{id}

Request

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

Path parameters

idstring uuid required

The unique identifier for the resource.

Request body

namestring

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

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

    • 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

    • breaking

      the request property's maxLength was decreased to 40

    • breaking

      the request property's minLength was increased from 0 to 1

Some revisions have not been checked yet.