TimePhone-API

The TimePhone-API powers the magical payphone with the power to contact anyone, past or present, live or dead, real or fictional! Ask the operator to speak to anyone and TimePhone will make it happen!

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

1. npm install
2. npm run migrate
3. docker compose up -d to start the database and minio.
4. Configure mini as shown in the Storage documentation.
5. Configure your .env file, example below. See the Secrets documentation for more information.
6. npm run start
7. Navigate to http://localhost:3000/api for Swagger documentation.

example .env file

DATABASE_URL="postgresql://user:password@localhost:5433/time-phone?schema=public"
OPENAI_API_KEY=""
GCP_AUTHJSON_BASE64=""
AWS_ACCESS_KEY_ID=""
AWS_SECRET_ACCESS_KEY=""
AWS_S3_ENDPOINT="http://minio:9000"
AWS_S3_BUCKET=""
AWS_S3_REGION=""

Usage

Create a new conversation

Start a new conversation by passing the /calls endpoint a POST request with a JSON body containing the character and prompt keys. The character information will be used to select a suitable voice for the call. The prompt will "program" the conversation and will be used to generate the first response.

curl --request POST \
  --url http://timephone:3000/calls \
  --header 'Content-Type: application/json' \
  --data '{
  "character": "Max Planck",
 "prompt": "You must pretend to be Max Planck, you know their life history and will speak in their style. Begin the conversation as you would answer a phone in live conversation as your new persona."
}'

You will get back a response containing the call id which can be used for posting new messages to the conversation. You will also get back a prompt which is the first response from the AI.

{
 "id": 10,
 "character": "Max Planck",
 "createdAt": "2023-03-28T00:42:29.947Z",
 "prompt": "You must pretend to be Max Planck, you know their life history and will speak in their style. Begin the conversation as you would answer a phone in live conversation as your new persona.",
 "response": {
  "text": "\"Good day, this is Max Planck speaking. How may I assist you?\""
 }
}

Continue a conversation

Send messages to an existing conversation by sending your audio and callId to the /messages endpoint.

curl --request POST \
  --url http://timephone:3000/messages \
  --header 'Content-Type: multipart/form-data' \
  --form callId=96 \
  --form 'audio=@when_were_you_born.mp3'

You will receive a response containing the prompt which is the AI's response to your message.

{
 "callId": 10,
 "request": {
  "text": "And what year were you born?"
 },
 "response": {
  "text": "I was born on April 23, 1858.",
  "audio": "http://timephone:9000/timephone/1679964871156-i-was-born-on-april-23--1858-.mp3"
 }
}