Struct CreateWorkflowDto

pub struct CreateWorkflowDto {

    pub nodes: Vec<WorkflowUserEditableNodesInner>,
    pub transcriber: Option<WorkflowUserEditableTranscriber>,
    pub voice: Option<WorkflowUserEditableVoice>,
    pub observability_plan: Option<LangfuseObservabilityPlan>,
    pub credentials: Option<Vec<WorkflowUserEditableCredentialsInner>>,
    pub name: String,
    pub edges: Vec<Edge>,
    pub global_prompt: Option<String>,
    pub server: Option<Server>,
    pub compliance_plan: Option<CompliancePlan>,
    pub analysis_plan: Option<AnalysisPlan>,
    pub artifact_plan: Option<ArtifactPlan>,
    pub start_speaking_plan: Option<StartSpeakingPlan>,
    pub stop_speaking_plan: Option<StopSpeakingPlan>,
    pub monitor_plan: Option<MonitorPlan>,
    pub background_speech_denoising_plan: Option<BackgroundSpeechDenoisingPlan>,
    pub credential_ids: Option<Vec<String>>,
}

Fields

nodes: Vec<WorkflowUserEditableNodesInner>

transcriber: Option<WorkflowUserEditableTranscriber>

voice: Option<WorkflowUserEditableVoice>

observability_plan: Option<LangfuseObservabilityPlan>

This is the plan for observability of workflow’s calls. Currently, only Langfuse is supported.

credentials: Option<Vec<WorkflowUserEditableCredentialsInner>>

These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.

name: String

edges: Vec<Edge>

global_prompt: Option<String>

server: Option<Server>

This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is: 1. tool.server 2. workflow.server / assistant.server 3. phoneNumber.server 4. org.server

compliance_plan: Option<CompliancePlan>

This is the compliance plan for the workflow. It allows you to configure HIPAA and other compliance settings.

analysis_plan: Option<AnalysisPlan>

This is the plan for analysis of workflow’s calls. Stored in call.analysis.

artifact_plan: Option<ArtifactPlan>

This is the plan for artifacts generated during workflow’s calls. Stored in call.artifact.

start_speaking_plan: Option<StartSpeakingPlan>

This is the plan for when the workflow nodes should start talking. You should configure this if you’re running into these issues: - The assistant is too slow to start talking after the customer is done speaking. - The assistant is too fast to start talking after the customer is done speaking. - The assistant is so fast that it’s actually interrupting the customer.

stop_speaking_plan: Option<StopSpeakingPlan>

This is the plan for when workflow nodes should stop talking on customer interruption. You should configure this if you’re running into these issues: - The assistant is too slow to recognize customer’s interruption. - The assistant is too fast to recognize customer’s interruption. - The assistant is getting interrupted by phrases that are just acknowledgments. - The assistant is getting interrupted by background noises. - The assistant is not properly stopping – it starts talking right after getting interrupted.

monitor_plan: Option<MonitorPlan>

This is the plan for real-time monitoring of the workflow’s calls. Usage: - To enable live listening of the workflow’s calls, set monitorPlan.listenEnabled to true. - To enable live control of the workflow’s calls, set monitorPlan.controlEnabled to true.

background_speech_denoising_plan: Option<BackgroundSpeechDenoisingPlan>

This enables filtering of noise and background speech while the user is talking. Features: - Smart denoising using Krisp - Fourier denoising Both can be used together. Order of precedence: - Smart denoising - Fourier denoising

credential_ids: Option<Vec<String>>

These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this.

Implementations

impl CreateWorkflowDto

pub fn new( nodes: Vec<WorkflowUserEditableNodesInner>, name: String, edges: Vec<Edge>, ) -> CreateWorkflowDto

Trait Implementations

impl Clone for CreateWorkflowDto

fn clone(&self) -> CreateWorkflowDto

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWorkflowDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateWorkflowDto

fn default() -> CreateWorkflowDto

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateWorkflowDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateWorkflowDto

fn eq(&self, other: &CreateWorkflowDto) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateWorkflowDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateWorkflowDto