Vapi icon

Vapi

Interact with the Vapi voice AI platform

File → Update

AI-generated

Summary

Update mutable fields of a file in the Vapi platform by file ID, allowing modification of the file's display name and metadata with optional JSON overrides.

Inputs

  • File ID (required) — The unique identifier of the Vapi file to update.
  • Update Fields — Collection of updateable file attributes including 'Name' (file display name, 1-40 characters), 'Metadata (JSON)' (advanced metadata supported by your Vapi account or API version), and 'Advanced Raw Body (JSON)' (additional top-level JSON keys that override structured values).

Output shape

a single record representing the updated file data.

The operation sends a PATCH request to update the file. The 'Update Fields' collection fields and the optional 'Advanced Raw Body' JSON are merged to form the request body. The response contains the updated file object in JSON format.

Examples

Example 1: Update a file's display name and metadata

Specify the File ID to target the file; provide the new display name in 'Name' and any advanced metadata as JSON in 'Metadata (JSON)'. Optionally, use 'Advanced Raw Body (JSON)' to include or override additional fields not available in the UI.

Links

Discussion