Get Assistant

GET

https://api.vapi.ai/assistant/:id

GET

/assistant/:id

curl https://api.vapi.ai/assistant/id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "transcriber": {
    "agentContext": "string",
    "agentContextAutoUpdateEnabled": false,
    "confidenceThreshold": 0.4,
    "disablePartialTranscripts": true,
    "endOfTurnConfidenceThreshold": 0.7,
    "endUtteranceSilenceThreshold": 1.1,
    "fallbackPlan": {
      "transcribers": [
        {
          "agentContext": "string",
          "agentContextAutoUpdateEnabled": false,
          "confidenceThreshold": 0.4,
          "disablePartialTranscripts": true,
          "endOfTurnConfidenceThreshold": 0.7,
          "endUtteranceSilenceThreshold": 1.1,
          "formatTurns": true,
          "keytermsPrompt": [
            "string"
          ],
          "language": "multi",
          "languageCodes": [
            "en"
          ],
          "maxTurnSilence": 400,
          "minEndOfTurnSilenceWhenConfident": 160,
          "mode": "max_accuracy",
          "prompt": "string",
          "provider": "assembly-ai",
          "realtimeUrl": "string",
          "speechModel": "universal-streaming-english",
          "vadAssistedEndpointingEnabled": true,
          "wordBoost": [
            "string"
          ],
          "wordFinalizationMaxWaitTime": 160
        }
      ]
    },
    "formatTurns": true,
    "keytermsPrompt": [
      "string"
    ],
    "language": "multi",
    "languageCodes": [
      "en"
    ],
    "maxTurnSilence": 400,
    "minEndOfTurnSilenceWhenConfident": 160,
    "mode": "max_accuracy",
    "prompt": "string",
    "provider": "assembly-ai",
    "realtimeUrl": "string",
    "speechModel": "universal-streaming-english",
    "vadAssistedEndpointingEnabled": true,
    "wordBoost": [
      "string"
    ],
    "wordFinalizationMaxWaitTime": 160
  },
  "model": {
    "emotionRecognitionEnabled": true,
    "knowledgeBase": {
      "provider": "custom-knowledge-base",
      "server": {
        "backoffPlan": {
          "baseDelaySeconds": 1,
          "excludedStatusCodes": [
            400,
            401,
            403,
            404
          ],
          "maxRetries": 0,
          "type": "fixed"
        },
        "credentialId": "550e8400-e29b-41d4-a716-446655440000",
        "encryptedPaths": [
          "string"
        ],
        "headers": {},
        "staticIpAddressesEnabled": false,
        "timeoutSeconds": 20,
        "url": "string"
      }
    },
    "maxTokens": 5030,
    "messages": [
      {
        "content": "string",
        "role": "assistant"
      }
    ],
    "model": "claude-3-opus-20240229",
    "numFastTurns": 1.1,
    "provider": "anthropic",
    "reasoningEffort": "none",
    "temperature": 1.1,
    "thinking": {
      "budgetTokens": 50500,
      "type": "enabled"
    },
    "toolIds": [
      "string"
    ],
    "toolRefs": [
      {
        "toolId": "string",
        "version": "string"
      }
    ],
    "tools": [
      {
        "backoffPlan": {
          "baseDelaySeconds": 1,
          "excludedStatusCodes": [
            400,
            401,
            403,
            404
          ],
          "maxRetries": 0,
          "type": "fixed"
        },
        "body": {
          "description": "string",
          "enum": [
            "string"
          ],
          "format": "date-time",
          "items": {
            "description": "string",
            "enum": [
              "string"
            ],
            "format": "date-time",
            "items": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              },
              "pattern": "string",
              "properties": {},
              "required": [
                "string"
              ],
              "title": "string",
              "type": "string"
            },
            "pattern": "string",
            "properties": {},
            "required": [
              "string"
            ],
            "title": "string",
            "type": "string"
          },
          "pattern": "string",
          "properties": {},
          "required": [
            "string"
          ],
          "title": "string",
          "type": "string"
        },
        "credentialId": "550e8400-e29b-41d4-a716-446655440000",
        "description": "string",
        "encryptedPaths": [
          "string"
        ],
        "headers": {
          "description": "string",
          "enum": [
            "string"
          ],
          "format": "date-time",
          "items": {
            "description": "string",
            "enum": [
              "string"
            ],
            "format": "date-time",
            "items": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              },
              "pattern": "string",
              "properties": {},
              "required": [
                "string"
              ],
              "title": "string",
              "type": "string"
            },
            "pattern": "string",
            "properties": {},
            "required": [
              "string"
            ],
            "title": "string",
            "type": "string"
          },
          "pattern": "string",
          "properties": {},
          "required": [
            "string"
          ],
          "title": "string",
          "type": "string"
        },
        "messages": [
          {
            "blocking": false,
            "conditions": [
              {
                "operator": "eq",
                "param": "string",
                "value": "string"
              }
            ],
            "content": "string",
            "contents": [
              {
                "language": "aa",
                "text": "string",
                "type": "text"
              }
            ],
            "type": "request-start"
          }
        ],
        "method": "POST",
        "name": "string",
        "parameters": [
          {
            "key": "string",
            "value": {}
          }
        ],
        "rejectionPlan": {
          "conditions": [
            {
              "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words",
              "type": "regex"
            }
          ]
        },
        "timeoutSeconds": 20,
        "type": "apiRequest",
        "url": "string",
        "variableExtractionPlan": {
          "aliases": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "schema": {
            "description": "string",
            "enum": [
              "string"
            ],
            "format": "date-time",
            "items": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              },
              "pattern": "string",
              "properties": {},
              "required": [
                "string"
              ],
              "title": "string",
              "type": "string"
            },
            "pattern": "string",
            "properties": {},
            "required": [
              "string"
            ],
            "title": "string",
            "type": "string"
          }
        }
      }
    ]
  },
  "voice": {
    "cachingEnabled": true,
    "chunkPlan": {
      "enabled": true,
      "formatPlan": {
        "enabled": true,
        "formattersEnabled": "markdown",
        "numberToDigitsCutoff": 2025,
        "replacements": [
          {
            "key": "string",
            "replaceAllEnabled": false,
            "type": "exact",
            "value": "string"
          }
        ]
      },
      "minCharacters": 30,
      "punctuationBoundaries": "。"
    },
    "fallbackPlan": {
      "voices": [
        {
          "cachingEnabled": true,
          "chunkPlan": {
            "enabled": true,
            "formatPlan": {
              "enabled": true,
              "formattersEnabled": "markdown",
              "numberToDigitsCutoff": 2025,
              "replacements": [
                {
                  "key": "string",
                  "replaceAllEnabled": false,
                  "type": "exact",
                  "value": "string"
                }
              ]
            },
            "minCharacters": 30,
            "punctuationBoundaries": "。"
          },
          "oneOf": null,
          "provider": "azure",
          "speed": 1.1,
          "voiceId": "andrew"
        }
      ]
    },
    "provider": "azure",
    "speed": 1.1,
    "voiceId": "andrew"
  },
  "firstMessage": "Hello! How can I help you today?",
  "firstMessageInterruptionsEnabled": false,
  "firstMessageMode": "assistant-speaks-first",
  "voicemailDetection": "off",
  "clientMessages": "conversation-update",
  "serverMessages": "assistant.started",
  "maxDurationSeconds": 600,
  "backgroundSound": "off",
  "modelOutputInMessagesEnabled": false,
  "transportConfigurations": [
    {
      "provider": "twilio",
      "record": false,
      "recordingChannels": "mono",
      "timeout": 60
    }
  ],
  "observabilityPlan": {
    "provider": "langfuse",
    "tags": [
      "string"
    ],
    "promptName": "string",
    "promptVersion": 1.1,
    "traceName": "string",
    "metadata": {}
  },
  "credentials": [
    {
      "provider": "anthropic",
      "apiKey": "string",
      "name": "string"
    }
  ],
  "hooks": [
    {
      "do": [
        {
          "tool": {
            "backoffPlan": {
              "baseDelaySeconds": 1,
              "excludedStatusCodes": [
                400,
                401,
                403,
                404
              ],
              "maxRetries": 0,
              "type": "fixed"
            },
            "body": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              },
              "pattern": "string",
              "properties": {},
              "required": [
                "string"
              ],
              "title": "string",
              "type": "string"
            },
            "credentialId": "550e8400-e29b-41d4-a716-446655440000",
            "description": "string",
            "encryptedPaths": [
              "string"
            ],
            "headers": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              },
              "pattern": "string",
              "properties": {},
              "required": [
                "string"
              ],
              "title": "string",
              "type": "string"
            },
            "messages": [
              {
                "blocking": false,
                "conditions": [
                  {
                    "operator": "eq",
                    "param": "string",
                    "value": "string"
                  }
                ],
                "content": "string",
                "contents": [
                  {
                    "language": "aa",
                    "text": "string",
                    "type": "text"
                  }
                ],
                "type": "request-start"
              }
            ],
            "method": "POST",
            "name": "string",
            "parameters": [
              {
                "key": "string",
                "value": {}
              }
            ],
            "rejectionPlan": {
              "conditions": [
                {
                  "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words",
                  "type": "regex"
                }
              ]
            },
            "timeoutSeconds": 20,
            "type": "apiRequest",
            "url": "string",
            "variableExtractionPlan": {
              "aliases": [
                {
                  "key": "string",
                  "value": "string"
                }
              ],
              "schema": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {},
                        "pattern": {},
                        "properties": {},
                        "required": {},
                        "title": {},
                        "type": {}
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "pattern": "string",
                  "properties": {},
                  "required": [
                    "string"
                  ],
                  "title": "string",
                  "type": "string"
                },
                "pattern": "string",
                "properties": {},
                "required": [
                  "string"
                ],
                "title": "string",
                "type": "string"
              }
            }
          },
          "toolId": "string",
          "type": "tool"
        }
      ],
      "filters": [
        {
          "key": "string",
          "oneOf": [
            "string"
          ],
          "type": "oneOf"
        }
      ],
      "on": "call.ending"
    }
  ],
  "latestVersion": "string",
  "modelDeprecations": [
    {
      "slot": "model.fallbackModels[1]",
      "provider": "openai",
      "model": "gpt-4-1106-preview",
      "deprecationDate": "2025-09-26",
      "retirementDate": "2026-03-26",
      "replacementStatus": "manual-action-required",
      "replacementModel": "gpt-5"
    }
  ],
  "name": "string",
  "voicemailMessage": "string",
  "endCallMessage": "string",
  "endCallPhrases": [
    "string"
  ],
  "compliancePlan": {
    "hipaaEnabled": true,
    "pciEnabled": {
      "pciEnabled": false
    },
    "securityFilterPlan": {
      "enabled": false,
      "filters": [
        {}
      ],
      "mode": "sanitize",
      "replacementText": "[FILTERED]"
    },
    "recordingConsentPlan": {
      "type": "stay-on-line",
      "message": "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.",
      "firstMessageMode": "assistant-speaks-first",
      "voice": {
        "cachingEnabled": true,
        "chunkPlan": {
          "enabled": true,
          "formatPlan": {
            "enabled": true,
            "formattersEnabled": "markdown",
            "numberToDigitsCutoff": 2025,
            "replacements": [
              {
                "key": "string",
                "replaceAllEnabled": false,
                "type": "exact",
                "value": "string"
              }
            ]
          },
          "minCharacters": 30,
          "punctuationBoundaries": "。"
        },
        "fallbackPlan": {
          "voices": [
            {
              "cachingEnabled": true,
              "chunkPlan": {
                "enabled": true,
                "formatPlan": {
                  "enabled": true,
                  "formattersEnabled": "markdown",
                  "numberToDigitsCutoff": 2025,
                  "replacements": [
                    {
                      "key": {},
                      "replaceAllEnabled": {},
                      "type": {},
                      "value": {}
                    }
                  ]
                },
                "minCharacters": 30,
                "punctuationBoundaries": "。"
              },
              "oneOf": null,
              "provider": "azure",
              "speed": 1.1,
              "voiceId": "andrew"
            }
          ]
        },
        "provider": "azure",
        "speed": 1.1,
        "voiceId": "andrew"
      },
      "waitSeconds": 3
    }
  },
  "metadata": {},
  "backgroundSpeechDenoisingPlan": {
    "smartDenoisingPlan": {
      "enabled": true
    },
    "fourierDenoisingPlan": {
      "enabled": false,
      "mediaDetectionEnabled": true,
      "staticThreshold": -35,
      "baselineOffsetDb": -15,
      "windowSizeMs": 3000,
      "baselinePercentile": 85
    }
  },
  "artifactPlan": {
    "recordingEnabled": true,
    "recordingFormat": "wav;l16",
    "recordingUseCustomStorageEnabled": true,
    "videoRecordingEnabled": false,
    "fullMessageHistoryEnabled": false,
    "pcapEnabled": true,
    "pcapS3PathPrefix": "/pcaps",
    "pcapUseCustomStorageEnabled": true,
    "loggingEnabled": true,
    "loggingUseCustomStorageEnabled": true,
    "transcriptPlan": {
      "enabled": true,
      "assistantName": "string",
      "userName": "string"
    },
    "recordingPath": "string",
    "structuredOutputIds": [
      "string"
    ],
    "structuredOutputs": [
      {
        "name": "string",
        "schema": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": "string",
                        "items": {
                          "type": "string",
                          "items": {
                            "type": {},
                            "items": {},
                            "properties": {},
                            "description": {},
                            "pattern": {},
                            "format": {},
                            "required": {},
                            "enum": {},
                            "title": {}
                          },
                          "properties": {},
                          "description": "string",
                          "pattern": "string",
                          "format": "date-time",
                          "required": [
                            "string"
                          ],
                          "enum": [
                            "string"
                          ],
                          "title": "string"
                        },
                        "properties": {},
                        "description": "string",
                        "pattern": "string",
                        "format": "date-time",
                        "required": [
                          "string"
                        ],
                        "enum": [
                          "string"
                        ],
                        "title": "string"
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "type": "ai",
        "regex": "string",
        "model": {
          "maxTokens": 5030,
          "messages": [
            {
              "content": "string",
              "role": "assistant"
            }
          ],
          "model": "gpt-6-luna",
          "provider": "openai",
          "temperature": 1.1
        },
        "compliancePlan": {
          "forceStoreOnHipaaEnabled": false
        },
        "conditions": [
          {
            "count": 4,
            "type": "minMessages"
          },
          {
            "seconds": 10,
            "type": "minCallDuration"
          }
        ],
        "description": "string",
        "assistantIds": [
          "string"
        ],
        "workflowIds": [
          "string"
        ]
      }
    ],
    "scorecardIds": [
      "string"
    ],
    "scorecards": [
      {
        "metrics": [
          {
            "conditions": [
              {
                "comparator": "=",
                "points": 1.1,
                "type": "comparator",
                "value": 1.1
              }
            ],
            "structuredOutputId": "string"
          }
        ],
        "name": "string",
        "description": "string",
        "assistantIds": [
          "string"
        ]
      }
    ],
    "loggingPath": "string"
  },
  "startSpeakingPlan": {
    "waitSeconds": 0.4,
    "smartEndpointingPlan": {
      "provider": "vapi"
    },
    "customEndpointingRules": [
      {
        "regex": "string",
        "regexOptions": [
          {
            "enabled": true,
            "type": "ignore-case"
          }
        ],
        "timeoutSeconds": 1.1