POST
/
generativeagent
/
v1
/
streams
Create stream URL
curl --request POST \
  --url https://api.sandbox.asapp.com/generativeagent/v1/streams \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "streamId": "97555020-0276-435f-8104-c378221ba292"
}'
{
  "streamId": "97555020-0276-435f-8104-c378221ba292",
  "streamingUrl": "https://ws-co82129c.test.asapp.com/push-api/connect/sse\\?token\\=<token>",
  "messageTypes": [
    "generative-agent-message"
  ]
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Body

application/json

The parameters to be associated with a given connection.

​
streamId
string

streamId to be associated with the streaming connection. If not present, the llm-bot will provide one.

Example:

"97555020-0276-435f-8104-c378221ba292"

Response

Successfully generated a new streaming URL.

Streaming URL with its identifier and possible SSE message-types to be received.

​
streamId
string
required

If it was provided in the request, this field will just reaffirm the value. Otherwise, a newly generated one will be provided.

Example:

"97555020-0276-435f-8104-c378221ba292"

​
streamingUrl
string
required

URL for opening the SSE session. It may be used once, and is valid for only 30 seconds.

Example:

"https://ws-co82129c.test.asapp.com/push-api/connect/sse\\?token\\=<token>"

​
messageTypes
string[]
required

Possible message types to be received from the agent.

Example:
["generative-agent-message"]