latestOpenAPI 3.1.02026-08-22360412712.1 KB

b5daa886f4ee

Agent Workflow15

Agents11

Alerts6

Aligned Diff1

Amelia4

BBB2

bland4

Bluejay as Code2

BluejayAI References2

Call Logs9

Communities7

Custom Metric Templates8

Custom Metrics21

Customer Personas5

Customer Traits6

Dashboards9

Digital Humans20

Documents6

ElevenLabs6

Evaluate2

Folders7

Goals1

google_agents3

google_ces2

google_dfcx1

HTTP Text Agent3

Human Edits12

Integration Keys5

Issues3

Journey Steps1

Knowledge Bases7

Labels5

Live Transcripts1

livekit1

Metrics Lab12

Metronome Webhook1

Observability Conversations2

oidc2

Optimize2

Phone Number Management3

Phone Numbers1

Preview Chat1

Prompts12

Queue Simulation Run1

Re-evaluate2

Red-Team Simulations4

Regeneration1

Rerun Simulation Results1

retell3

Retrieve Simulation Results2

Scenario Builder9

Self-Improve4

Simulation Results1

Simulation Runs2

Simulations10

Slack Assistant2

SMS Testing4

Subscription10

Text Simulations2

Traces3

Translation1

Twilio SIP Webhook1

Uptime10

Usage Alerts4

vapi8

Voice Clones4

Voice Generation1

Webhook Management4

Weekly notifications1

Widgets6

Workflow Extraction4

Webhooks

postWebhook: events_webhook

Optimize

Optimize Metric Prompt With Diff

Optimize a metric prompt using human vs AI evaluation comparisons. evaluation_diffs is required and must not be empty.

post/v1/optimize/metric-prompt-with-diff

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

namestring required

The name of the custom metric to optimize.

promptstring required

The current evaluation system prompt to optimize.

additional_instructionsstring nullable

Additional instructions for the optimization.

diff_promptstring nullable

System/instruction for how to use evaluation_diffs. If omitted, a default is used.

Response

Successful Response

optimized_promptstring required

The optimized version of the custom metric prompt.