Skip to main content
POST
/
v1
/
orgs
/
{org_id}
/
responses
/
stream
Create Response Stream
curl --request POST \
  --url https://api.letpiper.com/v1/orgs/{org_id}/responses/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "session_id": "<string>",
  "profile_metadata": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

org_id
string<uuid>
required

Body

application/json

Request schema for generating agent responses.

agent_id
string<uuid>
required
message
string | null

Single user message. Omit or pass null for greeting generation.

session_id
string | null

Session ID for conversation threading.

profile_metadata
Profile Metadata · object

User profile metadata for personalization (e.g., user_name, preferences)

Response

Successful Response