API Reference

Start Agent Chat

post
https://api.whippy.co/v1/agents//chat

Starts a chat agent session in a conversation.

Agent must be active and use an active LLM.

The agent cannot access past messages unless the conversation_history placeholder is included in the prompt. Be sure to include it if past messages are important for the use case.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the agent to be used in the chat session.

Agent must:

  • Be active.
  • Use an active LLM.
Body Params

Start Agent Chat Request

string
required

Channel identifier (phone number or email) to be used for the chat session.

Channel must:

  • Be enabled.
  • Be of type phone, whatsapp, or email.
boolean
Defaults to false

Whether the agent should send an initial message to the contact after starting the chat session.

When set to true, the agent will automatically send the first message without waiting for the contact to message first. When set to false or not provided, only the chat session will be created and the agent will only send a message after the contact messages first.

string
required

Contact phone number or email address

string
enum
required

Type of chat communication

Allowed:
Responses

Callback

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago