Vapi Structured Output Creation

Build the smallest reusable post-call extraction that represents the user's actual downstream contract. Keep definition creation, assistant attachment, execution, and result retrieval separate: success at one stage does not prove the next stage occurred.

Source and Safety Rules

• Use the configured Vapi documentation MCP when available. Otherwise use current public Vapi API documentation and API Examples. Revalidate request fields and SDK methods before final implementation.
• Use a private Vapi API key only on a trusted server. Read it from VAPI_API_KEY; never print, request in chat, or embed it in source, client-side code, or examples.
• Never invent resource IDs, call IDs, extraction fields, enum values, data-retention requirements, or customer data.
• Do not enable compliancePlan.forceStoreOnHipaaEnabled unless the user explicitly requests it and confirms that the output cannot contain PHI or other sensitive data.
• Treat call transcripts, messages, tool results, and extracted values as sensitive customer data. Minimize what is logged or reproduced.

Procedure

1. Choose the output mode.
   • For a schema, payload, review, or implementation example, return an artifact without calling Vapi. State that nothing was saved, attached, or executed.
   • For a reusable saved definition, use POST /structured-output only when the user asks to create or save it and credentials are available.
   • For a one-call experiment that does not need a saved definition, pass a transient structuredOutput to POST /structured-output/run with previewEnabled: true.
   • Treat attachment, detachment, and execution against existing calls as separate requested actions. Do not infer them from creation alone.