Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milosgajdos/go-vocode
Go client for Vocode API
https://github.com/milosgajdos/go-vocode
agents client go golang llm tts-api voice-agents voice-assistant
Last synced: 27 days ago
JSON representation
Go client for Vocode API
- Host: GitHub
- URL: https://github.com/milosgajdos/go-vocode
- Owner: milosgajdos
- License: apache-2.0
- Created: 2024-05-15T16:44:45.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T08:02:46.000Z (4 months ago)
- Last Synced: 2024-07-11T13:57:07.122Z (4 months ago)
- Topics: agents, client, go, golang, llm, tts-api, voice-agents, voice-assistant
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-vocode
[](https://github.com/milosgajdos/go-vocode/actions?query=workflow%3ACI)
[](https://pkg.go.dev/github.com/milosgajdos/go-vocode)
[](https://opensource.org/licenses/Apache-2.0)
A Go module for [vocode.dev](https://www.vocode.dev/) API client.
The official [vocode.dev](https://www.vocode.dev/) API documentation, upon which this Go module has been built, can be found [here](https://docs.vocode.dev/api-reference).
# Get Started
Build the module
```shell
go build ./...
```
Run tests
```shell
go test ./...
```
You must sign up for the Vocode account and generate the API key, first, before you can use the API.
There are a few code samples available in the [examples](./examples) directory so please do have a look. They could give you an idea about how to use this Go module.
> [!IMPORTANT]
> Before you attempt to run the samples you must set an environment variable with the API key.
> These are automatically read by the client when it gets created; you can override them in your own code.
* `VOCODE_API_KEY`: Vocode API key
## Nix
There is a [Nix flake](https://nixos.wiki/wiki/Flakes) file available which lets you work on the Go module using nix.
Just run the following command and you are in the business:
```shell
nix develop
```
# Basics
Vocode lets you create conversational agents and make them available via a phone number.
Vocode currently provides two phone providers:
* [Twilio](https://www.twilio.com/en-us)
* [Vonage](https://www.vonage.co.uk/)
You must create an account with either before you can create a Vocode agent.
You can buy a phone number via the Vocode API, specifically the [Buy Number API endpoint](https://docs.vocode.dev/api-reference/numbers/buy-number).
You wil associate this number with an agent you'll create later on.
You can then proceed with configuring your agent:
* create a [voice config](./examples/voices)
* create conversational [prompt config](./examples/prompts)
* configure [agent actions](./examples/actions)
Once you've set up the phone number you can create an agent like so:
```Go
package main
import (
"context"
"flag"
"log"
"strings"
"github.com/milosgajdos/go-vocode"
)
var (
prompt string
voice string
actions string
)
func init() {
flag.StringVar(&prompt, "prompt", "", "prompt ID")
flag.StringVar(&voice, "voice", "", "voice ID")
flag.StringVar(&actions, "actions", "", "comma separated list of actions")
}
func main() {
flag.Parse()
client := vocode.NewClient()
ctx := context.Background()
ax := strings.Split(actions, ",")
createAgentReq := &vocode.CreateAgentReq{
AgentReq: vocode.AgentReq{
Name: "My Agent",
Prompt: prompt,
Voice: voice,
Language: vocode.English,
InterruptSense: vocode.LowInterruptSense,
EndpointSense: vocode.AutoEndpointSense,
IVRNavMode: vocode.OffIVRMode,
Speed: 1.0,
AsktIfHumanPresentOnIdle: true,
Actions: ax,
},
}
res, err := client.CreateAgent(ctx, createAgentReq)
if err != nil {
log.Fatalf("failed creating agent: %v", err)
}
log.Printf("created agent: %v", res)
}
```