CHchrt
/charlie

Start Charlie call

Changed on

Creates a voice call room with Charlie, CHRT's voice assistant, acting as the caller and returns a token to join it. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CharlieStartReq) -> (CharlieStartRes)

post/charlie/start/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/charlie/start/v1
  • Auth
    HTTP bearer

Request body

time_zonestring nullable

IANA time zone name (e.g. America/New_York).

conversation_idstring nullable

One of the caller's ChrtGPT conversations for the call to continue, with Charlie knowing its latest messages. Omit to start a new conversation.

Example request

{
  "time_zone": "America/New_York"
}

Response

Successful Response

server_urlstring required

The voice server to connect to with participant_token.

participant_tokenstring required

Joins only this call's room, as the caller.

conversation_idstring required

The call's ChrtGPT conversation: the one in the request, or a new one created on Charlie's first question to ChrtGPT, and until then not found.

Changes

  • 6f428e2e2b98Revision changes
    • info

      added the new optional request property

  • 9776098a73faRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status