Create stream URL

This API creates a generative agent event streaming URL to start a streaming connection (SSE).

This API should be called when the client boots-up to request a streaming_url, before it calls endpoints whose responses are delivered asynchronously (and most likely before calling any other endpoint).

Provide the streamId to reconnect to a previous stream.

Authorizations

asapp-api-id

string

headerrequired

asapp-api-secret

string

headerrequired

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.

Response

200 - application/json

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.

streamingUrl

string

required

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

messageTypes

string[]

required

Possible message types to be received from the agent.