vapi-server-sdk 0.0.0a7__py3-none-any.whl

vapi/types/call.py

@@ -0,0 +1,241 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+from .callback_step import CallbackStep
+from .create_workflow_block_dto import CreateWorkflowBlockDto
+from .handoff_step import HandoffStep
+import typing
+from .call_type import CallType
+import pydantic
+from .call_costs_item import CallCostsItem
+from .call_messages_item import CallMessagesItem
+import typing_extensions
+from .call_phone_call_provider import CallPhoneCallProvider
+from ..core.serialization import FieldMetadata
+from .call_phone_call_transport import CallPhoneCallTransport
+from .call_status import CallStatus
+from .call_ended_reason import CallEndedReason
+from .call_destination import CallDestination
+import datetime as dt
+from .cost_breakdown import CostBreakdown
+from .artifact_plan import ArtifactPlan
+from .analysis import Analysis
+from .monitor import Monitor
+from .artifact import Artifact
+from .create_assistant_dto import CreateAssistantDto
+from .assistant_overrides import AssistantOverrides
+from .create_squad_dto import CreateSquadDto
+from .import_twilio_phone_number_dto import ImportTwilioPhoneNumberDto
+from .create_customer_dto import CreateCustomerDto
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class Call(UniversalBaseModel):
+    type: typing.Optional[CallType] = pydantic.Field(default=None)
+    """
+    This is the type of call.
+    """
+
+    costs: typing.Optional[typing.List[CallCostsItem]] = pydantic.Field(default=None)
+    """
+    These are the costs of individual components of the call in USD.
+    """
+
+    messages: typing.Optional[typing.List[CallMessagesItem]] = None
+    phone_call_provider: typing_extensions.Annotated[
+        typing.Optional[CallPhoneCallProvider], FieldMetadata(alias="phoneCallProvider")
+    ] = pydantic.Field(default=None)
+    """
+    This is the provider of the call.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    phone_call_transport: typing_extensions.Annotated[
+        typing.Optional[CallPhoneCallTransport], FieldMetadata(alias="phoneCallTransport")
+    ] = pydantic.Field(default=None)
+    """
+    This is the transport of the phone call.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    status: typing.Optional[CallStatus] = pydantic.Field(default=None)
+    """
+    This is the status of the call.
+    """
+
+    ended_reason: typing_extensions.Annotated[typing.Optional[CallEndedReason], FieldMetadata(alias="endedReason")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the explanation for how the call ended.
+    """
+
+    destination: typing.Optional[CallDestination] = pydantic.Field(default=None)
+    """
+    This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the call.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the org that this call belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the call was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the call was last updated.
+    """
+
+    started_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="startedAt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the ISO 8601 date-time string of when the call was started.
+    """
+
+    ended_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="endedAt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the ISO 8601 date-time string of when the call was ended.
+    """
+
+    cost: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of the call in USD.
+    """
+
+    cost_breakdown: typing_extensions.Annotated[
+        typing.Optional[CostBreakdown], FieldMetadata(alias="costBreakdown")
+    ] = pydantic.Field(default=None)
+    """
+    This is the cost of the call in USD.
+    """
+
+    artifact_plan: typing_extensions.Annotated[typing.Optional[ArtifactPlan], FieldMetadata(alias="artifactPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is a copy of assistant artifact plan. This isn't actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.
+    """
+
+    analysis: typing.Optional[Analysis] = pydantic.Field(default=None)
+    """
+    This is the analysis of the call. Configure in `assistant.analysisPlan`.
+    """
+
+    monitor: typing.Optional[Monitor] = pydantic.Field(default=None)
+    """
+    This is to real-time monitor the call. Configure in `assistant.monitorPlan`.
+    """
+
+    artifact: typing.Optional[Artifact] = pydantic.Field(default=None)
+    """
+    These are the artifacts created from the call. Configure in `assistant.artifactPlan`.
+    """
+
+    phone_call_provider_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="phoneCallProviderId")
+    ] = pydantic.Field(default=None)
+    """
+    The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    assistant_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="assistantId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead.
+    """
+
+    assistant: typing.Optional[CreateAssistantDto] = pydantic.Field(default=None)
+    """
+    This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.
+    """
+
+    assistant_overrides: typing_extensions.Annotated[
+        typing.Optional[AssistantOverrides], FieldMetadata(alias="assistantOverrides")
+    ] = pydantic.Field(default=None)
+    """
+    These are the overrides for the `assistant` or `assistantId`'s settings and template variables.
+    """
+
+    squad_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="squadId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the squad that will be used for the call. To use a transient squad, use `squad` instead.
+    """
+
+    squad: typing.Optional[CreateSquadDto] = pydantic.Field(default=None)
+    """
+    This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.
+    """
+
+    phone_number_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="phoneNumberId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    phone_number: typing_extensions.Annotated[
+        typing.Optional[ImportTwilioPhoneNumberDto], FieldMetadata(alias="phoneNumber")
+    ] = pydantic.Field(default=None)
+    """
+    This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    customer_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customerId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the customer that will be called. To call a transient customer , use `customer` instead.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    customer: typing.Optional[CreateCustomerDto] = pydantic.Field(default=None)
+    """
+    This is the customer that will be called. To call an existing customer, use `customerId` instead.
+    
+    Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the call. This is just for your own reference.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+update_forward_refs(CallbackStep, Call=Call)
+update_forward_refs(CreateWorkflowBlockDto, Call=Call)
+update_forward_refs(HandoffStep, Call=Call)

vapi/types/call_costs_item.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .transport_cost import TransportCost
+from .transcriber_cost import TranscriberCost
+from .model_cost import ModelCost
+from .voice_cost import VoiceCost
+from .vapi_cost import VapiCost
+from .analysis_cost import AnalysisCost
+
+CallCostsItem = typing.Union[TransportCost, TranscriberCost, ModelCost, VoiceCost, VapiCost, AnalysisCost]

vapi/types/call_destination.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .transfer_destination_number import TransferDestinationNumber
+from .transfer_destination_sip import TransferDestinationSip
+
+CallDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/call_ended_reason.py

@@ -0,0 +1,177 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallEndedReason = typing.Union[
+    typing.Literal[
+        "assistant-error",
+        "assistant-not-found",
+        "db-error",
+        "no-server-available",
+        "license-check-failed",
+        "pipeline-error-openai-llm-failed",
+        "pipeline-error-azure-openai-llm-failed",
+        "pipeline-error-groq-llm-failed",
+        "pipeline-error-anthropic-llm-failed",
+        "pipeline-error-vapi-llm-failed",
+        "pipeline-error-vapi-400-bad-request-validation-failed",
+        "pipeline-error-vapi-401-unauthorized",
+        "pipeline-error-vapi-403-model-access-denied",
+        "pipeline-error-vapi-429-exceeded-quota",
+        "pipeline-error-vapi-500-server-error",
+        "pipeline-error-openai-voice-failed",
+        "pipeline-error-cartesia-voice-failed",
+        "pipeline-error-deepgram-transcriber-failed",
+        "pipeline-error-deepgram-voice-failed",
+        "pipeline-error-gladia-transcriber-failed",
+        "pipeline-error-eleven-labs-voice-failed",
+        "pipeline-error-playht-voice-failed",
+        "pipeline-error-lmnt-voice-failed",
+        "pipeline-error-azure-voice-failed",
+        "pipeline-error-rime-ai-voice-failed",
+        "pipeline-error-neets-voice-failed",
+        "pipeline-no-available-model",
+        "worker-shutdown",
+        "unknown-error",
+        "vonage-disconnected",
+        "vonage-failed-to-connect-call",
+        "phone-call-provider-bypass-enabled-but-no-call-received",
+        "vapifault-phone-call-worker-setup-socket-error",
+        "vapifault-phone-call-worker-worker-setup-socket-timeout",
+        "vapifault-phone-call-worker-could-not-find-call",
+        "vapifault-transport-never-connected",
+        "vapifault-web-call-worker-setup-failed",
+        "vapifault-transport-connected-but-call-not-active",
+        "assistant-not-invalid",
+        "assistant-not-provided",
+        "call-start-error-neither-assistant-nor-server-set",
+        "assistant-request-failed",
+        "assistant-request-returned-error",
+        "assistant-request-returned-unspeakable-error",
+        "assistant-request-returned-invalid-assistant",
+        "assistant-request-returned-no-assistant",
+        "assistant-request-returned-forwarding-phone-number",
+        "assistant-ended-call",
+        "assistant-said-end-call-phrase",
+        "assistant-forwarded-call",
+        "assistant-join-timed-out",
+        "customer-busy",
+        "customer-ended-call",
+        "customer-did-not-answer",
+        "customer-did-not-give-microphone-permission",
+        "assistant-said-message-with-end-call-enabled",
+        "exceeded-max-duration",
+        "manually-canceled",
+        "phone-call-provider-closed-websocket",
+        "pipeline-error-openai-400-bad-request-validation-failed",
+        "pipeline-error-openai-401-unauthorized",
+        "pipeline-error-openai-403-model-access-denied",
+        "pipeline-error-openai-429-exceeded-quota",
+        "pipeline-error-openai-500-server-error",
+        "pipeline-error-azure-openai-400-bad-request-validation-failed",
+        "pipeline-error-azure-openai-401-unauthorized",
+        "pipeline-error-azure-openai-403-model-access-denied",
+        "pipeline-error-azure-openai-429-exceeded-quota",
+        "pipeline-error-azure-openai-500-server-error",
+        "pipeline-error-groq-400-bad-request-validation-failed",
+        "pipeline-error-groq-401-unauthorized",
+        "pipeline-error-groq-403-model-access-denied",
+        "pipeline-error-groq-429-exceeded-quota",
+        "pipeline-error-groq-500-server-error",
+        "pipeline-error-anthropic-400-bad-request-validation-failed",
+        "pipeline-error-anthropic-401-unauthorized",
+        "pipeline-error-anthropic-403-model-access-denied",
+        "pipeline-error-anthropic-429-exceeded-quota",
+        "pipeline-error-anthropic-500-server-error",
+        "pipeline-error-together-ai-400-bad-request-validation-failed",
+        "pipeline-error-together-ai-401-unauthorized",
+        "pipeline-error-together-ai-403-model-access-denied",
+        "pipeline-error-together-ai-429-exceeded-quota",
+        "pipeline-error-together-ai-500-server-error",
+        "pipeline-error-together-ai-llm-failed",
+        "pipeline-error-anyscale-400-bad-request-validation-failed",
+        "pipeline-error-anyscale-401-unauthorized",
+        "pipeline-error-anyscale-403-model-access-denied",
+        "pipeline-error-anyscale-429-exceeded-quota",
+        "pipeline-error-anyscale-500-server-error",
+        "pipeline-error-anyscale-llm-failed",
+        "pipeline-error-openrouter-400-bad-request-validation-failed",
+        "pipeline-error-openrouter-401-unauthorized",
+        "pipeline-error-openrouter-403-model-access-denied",
+        "pipeline-error-openrouter-429-exceeded-quota",
+        "pipeline-error-openrouter-500-server-error",
+        "pipeline-error-openrouter-llm-failed",
+        "pipeline-error-perplexity-ai-400-bad-request-validation-failed",
+        "pipeline-error-perplexity-ai-401-unauthorized",
+        "pipeline-error-perplexity-ai-403-model-access-denied",
+        "pipeline-error-perplexity-ai-429-exceeded-quota",
+        "pipeline-error-perplexity-ai-500-server-error",
+        "pipeline-error-perplexity-ai-llm-failed",
+        "pipeline-error-deepinfra-400-bad-request-validation-failed",
+        "pipeline-error-deepinfra-401-unauthorized",
+        "pipeline-error-deepinfra-403-model-access-denied",
+        "pipeline-error-deepinfra-429-exceeded-quota",
+        "pipeline-error-deepinfra-500-server-error",
+        "pipeline-error-deepinfra-llm-failed",
+        "pipeline-error-runpod-400-bad-request-validation-failed",
+        "pipeline-error-runpod-401-unauthorized",
+        "pipeline-error-runpod-403-model-access-denied",
+        "pipeline-error-runpod-429-exceeded-quota",
+        "pipeline-error-runpod-500-server-error",
+        "pipeline-error-runpod-llm-failed",
+        "pipeline-error-custom-llm-400-bad-request-validation-failed",
+        "pipeline-error-custom-llm-401-unauthorized",
+        "pipeline-error-custom-llm-403-model-access-denied",
+        "pipeline-error-custom-llm-429-exceeded-quota",
+        "pipeline-error-custom-llm-500-server-error",
+        "pipeline-error-custom-llm-llm-failed",
+        "pipeline-error-cartesia-socket-hang-up",
+        "pipeline-error-cartesia-requested-payment",
+        "pipeline-error-cartesia-500-server-error",
+        "pipeline-error-cartesia-503-server-error",
+        "pipeline-error-cartesia-522-server-error",
+        "pipeline-error-custom-voice-failed",
+        "pipeline-error-eleven-labs-voice-not-found",
+        "pipeline-error-eleven-labs-quota-exceeded",
+        "pipeline-error-eleven-labs-unauthorized-access",
+        "pipeline-error-eleven-labs-unauthorized-to-access-model",
+        "pipeline-error-eleven-labs-professional-voices-only-for-creator-plus",
+        "pipeline-error-eleven-labs-blocked-free-plan-and-requested-upgrade",
+        "pipeline-error-eleven-labs-blocked-concurrent-requests-and-requested-upgrade",
+        "pipeline-error-eleven-labs-blocked-using-instant-voice-clone-and-requested-upgrade",
+        "pipeline-error-eleven-labs-system-busy-and-requested-upgrade",
+        "pipeline-error-eleven-labs-voice-not-fine-tuned",
+        "pipeline-error-eleven-labs-invalid-api-key",
+        "pipeline-error-eleven-labs-invalid-voice-samples",
+        "pipeline-error-eleven-labs-voice-disabled-by-owner",
+        "pipeline-error-eleven-labs-blocked-account-in-probation",
+        "pipeline-error-eleven-labs-blocked-content-against-their-policy",
+        "pipeline-error-eleven-labs-missing-samples-for-voice-clone",
+        "pipeline-error-eleven-labs-voice-not-fine-tuned-and-cannot-be-used",
+        "pipeline-error-eleven-labs-voice-not-allowed-for-free-users",
+        "pipeline-error-eleven-labs-500-server-error",
+        "pipeline-error-eleven-labs-max-character-limit-exceeded",
+        "pipeline-error-playht-request-timed-out",
+        "pipeline-error-playht-invalid-voice",
+        "pipeline-error-playht-unexpected-error",
+        "pipeline-error-playht-out-of-credits",
+        "pipeline-error-playht-voice-must-be-a-valid-voice-manifest-uri",
+        "pipeline-error-playht-401-unauthorized",
+        "pipeline-error-playht-403-forbidden-out-of-characters",
+        "pipeline-error-playht-403-forbidden-api-access-not-available",
+        "pipeline-error-playht-429-exceeded-quota",
+        "pipeline-error-playht-502-gateway-error",
+        "pipeline-error-playht-504-gateway-error",
+        "pipeline-error-deepgram-403-model-access-denied",
+        "pipeline-error-deepgram-404-not-found",
+        "pipeline-error-deepgram-400-no-such-model-language-tier-combination",
+        "pipeline-error-deepgram-500-returning-invalid-json",
+        "sip-gateway-failed-to-connect-call",
+        "silence-timed-out",
+        "twilio-failed-to-connect-call",
+        "twilio-reported-customer-misdialed",
+        "voicemail",
+        "vonage-rejected",
+    ],
+    typing.Any,
+]

vapi/types/call_messages_item.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .user_message import UserMessage
+from .system_message import SystemMessage
+from .bot_message import BotMessage
+from .tool_call_message import ToolCallMessage
+from .tool_call_result_message import ToolCallResultMessage
+
+CallMessagesItem = typing.Union[UserMessage, SystemMessage, BotMessage, ToolCallMessage, ToolCallResultMessage]

vapi/types/call_paginated_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+from .callback_step import CallbackStep
+from .create_workflow_block_dto import CreateWorkflowBlockDto
+from .handoff_step import HandoffStep
+import typing
+from .call import Call
+from .pagination_meta import PaginationMeta
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class CallPaginatedResponse(UniversalBaseModel):
+    results: typing.List[Call]
+    metadata: PaginationMeta
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+update_forward_refs(CallbackStep, CallPaginatedResponse=CallPaginatedResponse)
+update_forward_refs(CreateWorkflowBlockDto, CallPaginatedResponse=CallPaginatedResponse)
+update_forward_refs(HandoffStep, CallPaginatedResponse=CallPaginatedResponse)

vapi/types/call_phone_call_provider.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallPhoneCallProvider = typing.Union[typing.Literal["twilio", "vonage", "vapi"], typing.Any]

vapi/types/call_phone_call_transport.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallPhoneCallTransport = typing.Union[typing.Literal["sip", "pstn"], typing.Any]

vapi/types/call_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallStatus = typing.Union[typing.Literal["queued", "ringing", "in-progress", "forwarding", "ended"], typing.Any]

vapi/types/call_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallType = typing.Union[typing.Literal["inboundPhoneCall", "outboundPhoneCall", "webCall"], typing.Any]

vapi/types/callback_step.py

@@ -0,0 +1,116 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .assignment_mutation import AssignmentMutation
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class CallbackStep(UniversalBaseModel):
+    block: typing.Optional["CallbackStepBlock"] = pydantic.Field(default=None)
+    """
+    This is the block to use. To use an existing block, use `blockId`.
+    """
+
+    type: typing.Literal["callback"] = pydantic.Field(default="callback")
+    """
+    This is a step that calls back to the previous step after it's done. This effectively means we're spawning a new conversation thread. The previous conversation thread will resume where it left off once this step is done.
+    
+    Use case:
+    
+    - You are collecting a customer's order and while they were on one item, they start a new item or try to modify a previous one. You would make a OrderUpdate block which calls the same block repeatedly when a new update starts.
+    """
+
+    mutations: typing.Optional[typing.List[AssignmentMutation]] = pydantic.Field(default=None)
+    """
+    This is the mutations to apply to the context after the step is done.
+    """
+
+    name: str = pydantic.Field()
+    """
+    This is the name of the step.
+    """
+
+    block_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="blockId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the id of the block to use. To use a transient block, use `block`.
+    """
+
+    input: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is the input to the block. You can use any key-value map as input to the block.
+    
+    Example:
+    {
+    "name": "John Doe",
+    "age": 20
+    }
+    
+    You can reference any variable in the context of the current block:
+    
+    - "{{your-step-name.output.your-property-name}}" for another step's output (in the same workflow; read caveat #1)
+    - "{{your-step-name.input.your-property-name}}" for another step's input (in the same workflow; read caveat #1)
+    - "{{your-block-name.output.your-property-name}}" for another block's output (in the same workflow; read caveat #2)
+    - "{{your-block-name.input.your-property-name}}" for another block's input (in the same workflow; read caveat #2)
+    - "{{workflow.input.your-property-name}}" for the current workflow's input
+    - "{{global.your-property-name}}" for the global context
+    
+    Example:
+    {
+    "name": "{{my-tool-call-step.output.name}}",
+    "age": "{{my-tool-call-step.input.age}}",
+    "date": "{{workflow.input.date}}"
+    }
+    
+    You can dynamically change the key name.
+    
+    Example:
+    {
+    "{{my-tool-call-step.output.key-name-for-name}}": "{{name}}",
+    "{{my-tool-call-step.input.key-name-for-age}}": "{{age}}",
+    "{{workflow.input.key-name-for-date}}": "{{date}}"
+    }
+    
+    You can represent the value as a string, number, boolean, array, or object.
+    
+    Example:
+    {
+    "name": "john",
+    "age": 20,
+    "date": "2021-01-01",
+    "metadata": {
+    "unique-key": "{{my-tool-call-step.output.unique-key}}"
+    },
+    "array": ["A", "B", "C"],
+    }
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.input/output.propertyName}} will reference the latest usage of the step.
+    2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.input/output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+from .create_workflow_block_dto import CreateWorkflowBlockDto  # noqa: E402
+from .handoff_step import HandoffStep  # noqa: E402
+from .callback_step_block import CallbackStepBlock  # noqa: E402
+
+update_forward_refs(CreateWorkflowBlockDto, CallbackStep=CallbackStep)
+update_forward_refs(HandoffStep, CallbackStep=CallbackStep)
+update_forward_refs(CallbackStep)

vapi/types/callback_step_block.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+import typing
+from .create_conversation_block_dto import CreateConversationBlockDto
+from .create_tool_call_block_dto import CreateToolCallBlockDto
+import typing
+
+if typing.TYPE_CHECKING:
+    from .create_workflow_block_dto import CreateWorkflowBlockDto
+CallbackStepBlock = typing.Union[CreateConversationBlockDto, CreateToolCallBlockDto, "CreateWorkflowBlockDto"]