Design, create, inspect, update, attach, detach, preview, execute, and verify reusable Vapi Structured Outputs through public API or Server SDK workflows. Use for post-call extraction, typed call artifacts, AI-versus-regex extraction, JSON Schema design, backfilling existing calls, or retrieving structured results programmatically.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
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.
VAPI_API_KEY; never print, request in chat, or embed it in source, client-side code, or examples.compliancePlan.forceStoreOnHipaaEnabled unless the user explicitly requests it and confirms that the output cannot contain PHI or other sensitive data.Choose the output mode.
POST /structured-output only when the user asks to create or save it and credentials are available.structuredOutput to POST /structured-output/run with previewEnabled: true.Define the extraction contract.
Choose AI or regex.
type: "ai" for meaning, classification, summarization, sentiment, outcome detection, normalization, or facts expressed in varied language.type: "regex" only for deterministic transcript matching with a stable pattern. Use RE2-compatible syntax and choose a top-level schema type that matches the documented regex result: boolean, string, number/integer, or array.Design the smallest useful JSON Schema.
enum for a closed category set, format or pattern for externally validated strings, and numeric bounds when the business contract defines them.Create, inspect, or update the definition.
name and schema; add type, description, regex, model, or compliancePlan only when intentional.GET /structured-output/{id}. Do not guess from a partial name.schemaOverride=true only when intentionally changing the schema's top-level type; otherwise do not use it to bypass schema safety.Attach or detach safely.
assistantIds relationship for attachment. Read its current assistantIds, add or remove exactly the resolved assistant ID, and preserve every unrelated ID.assistantIds on the Structured Output for this operation. Re-fetch the Structured Output and assistant; verify the relationship and the assistant's artifactPlan.structuredOutputIds when returned.artifactPlan with only structuredOutputIds changed. Preserve recording, logging, transcript, scorecard, storage, and other artifact settings.Preview before broad execution.
POST /structured-output/run with one real call ID and previewEnabled: true. Supply either structuredOutputId or a transient structuredOutput, not both.Execute or backfill only when requested.
previewEnabled: false or omit it to update call artifacts. Pass no more than the currently documented maximum of 100 call IDs per request.Retrieve and verify results.
GET /call/{id} and read call.artifact.structuredOutputs[structuredOutputId].result.400, inspect the response for schema, regex, model, relationship, or run constraints. Correct one unambiguous documented issue and retry once; never repeat an unchanged request.401 or 403, stop and report authentication or permission failure.404, report the missing Structured Output, assistant, or call and identify the exact unresolved ID.409, re-read current state before deciding whether the intended relationship or update already exists.429 or 5xx, preserve the request context, report the service condition, and do not claim success.Read API Examples when implementation code is needed. Use the official TypeScript or Python Server SDK only after confirming the generated method in its current official reference; use direct REST when SDK syntax is unavailable or unstable.
Return only the sections relevant to the request:
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
Design, create, or validate saved and transient Vapi voice assistants. Use for new phone or web agents, production system prompts and first messages, saved-versus-transient architecture, model/voice/transcriber selection, multilingual compatibility, existing tool attachment, native call-control tools, assistant hooks, and Create Assistant API validation errors.
日本語の概要は準備中です。原文の説明を表示しています。
Create one-off outbound phone calls, web calls, scheduled calls, and simple batch calls using the Vapi API. Use when making or testing individual calls or initiating a bounded /call request programmatically. Use create-campaign for a persistent multi-contact Campaign with lifecycle, reporting, cancellation, duplication, or campaign webhooks.
日本語の概要は準備中です。原文の説明を表示しています。
Create, schedule, duplicate, inspect, cancel, archive, and troubleshoot Vapi outbound Campaigns. Use for persistent multi-contact calling, CSV or API contact personalization, campaign concurrency, campaign webhooks, pre-dial eligibility, contact outcomes, or rerunning an audience. Do not use for a single call or a simple one-off /call batch.
日本語の概要は準備中です。原文の説明を表示しています。
Plan, provision, import, route, update, and verify Vapi phone numbers through the public API. Use for Vapi-hosted US PSTN numbers, explicitly requested SIP addresses, Twilio/Vonage/Telnyx or BYO carrier numbers, secure credential handling, assistant or squad routing, area-code requests, outbound limitations, and phone-provider troubleshooting.
日本語の概要は準備中です。原文の説明を表示しています。
Design, create, update, and verify Vapi Squads and documented handoff tools through the public API. Use for choosing a single assistant versus a multi-assistant Squad, persistent or transient members, entry-member ordering, specialization boundaries, context engineering, variable extraction, model-specific handoff patterns, assistant-version pins, and safe Squad updates.
日本語の概要は準備中です。原文の説明を表示しています。
Select, define, create, inspect, update, attach, detach, and verify reusable Vapi tools through the public API. Use for native call-control tools, supported provider integrations, API Request tools, custom function tools, MCP tools, tool messages, credentials, or configuration-preserving assistant attachment changes.
日本語の概要は準備中です。原文の説明を表示しています。