Vapi Swift Library

The Vapi Swift library provides convenient access to the Vapi APIs from Swift.

Requirements

This SDK requires:

• Swift 5.7+
• iOS 15+
• macOS 12+
• tvOS 15+
• watchOS 8+

Installation

With Swift Package Manager (SPM), add the following to the top-level dependencies array within your Package.swift file:

dependencies: [
    .package(url: "https://github.com/VapiAI/server-sdk-swift.git", from: "1.0.0")
]

Note: If the package repository is not yet published, you can add it as a local package by specifying the path in Xcode or your Package.swift file.

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

import Foundation
import Vapi

private func main() async throws {
    let client = VapiClient(token: "<YOUR_TOKEN>")
    
    let call = try await client.calls.create(request: .init(
        name: "My Call",
        assistantId: "your-assistant-id"
    ))
}

try await main()

Request Types

The SDK exports all request types as Swift structs. Simply import the SDK module to access them:

import Vapi

let request = Requests.CreateCallDto(
    name: "My Call",
    assistantId: "your-assistant-id"
)

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a ClientError will be thrown:

do {
    try await client.calls.create(request: request)
} catch let error as ClientError {
    switch error {
    case .unauthorized(let response):
        print("Unauthorized: \(response?.message ?? "No message")")
    case .badRequest(let response):
        print("Bad request: \(response?.message ?? "No message")")
    case .serverError(let response):
        print("Server error: \(response?.message ?? "No message")")
    default:
        print("Error: \(error.errorDescription ?? "Unknown error")")
    }
}

Advanced

Additional Headers

If you would like to send additional headers as part of the request, use the additionalHeaders request option.

try await client.calls.create(request: request, requestOptions: .init(
    additionalHeaders: [
        "X-Custom-Header": "custom value"
    ]
))

Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the additionalQueryParameters request option.

try await client.calls.create(request: request, requestOptions: .init(
    additionalQueryParameters: [
        "custom_param": "custom_value"
    ]
))

Timeouts

The SDK defaults to a 60-second timeout. Use the timeout option to configure this behavior.

try await client.calls.create(request: request, requestOptions: .init(
    timeout: 30
))

Custom Networking Client

The SDK allows you to customize the underlying URLSession used for HTTP requests. Use the urlSession option to provide your own configured URLSession instance.

import Foundation
import Vapi

let client = VapiClient(
    token: "<YOUR_TOKEN>",
    urlSession: // Provide your implementation here
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!