Streaming

Create a streaming credential for a thread

Returns a short-lived, thread-scoped token your frontend can use to subscribe to live token output over SSE. Call this from your backend with your API key, then hand the token to the browser — the API key itself must never leave your server. The thread does not have to exist yet: mint a token, connect, then start the run. Connect before triggering a run, since tokens emitted while nobody is subscribed are not replayed.

POST

api

threads

{thread}

stream-token

PromptJuggler PHP SDK

$token = $pj->createStreamToken('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10');

const token = await pj.createStreamToken('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10');

token = pj.create_stream_token('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10')

StreamTokenResponse token = pj.createStreamToken("0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10");

token, err := pj.CreateStreamToken(ctx, "0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10")

curl --request POST \
  --url https://promptjuggler.com/api/v1/threads/{thread}/stream-token \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://promptjuggler.com/api/v1/threads/{thread}/stream-token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://promptjuggler.com/api/v1/threads/{thread}/stream-token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "token": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "url": "https://stream.promptjuggler.com/stream/0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

thread

string<uuid>

required

Thread ID to subscribe to. Any UUID you intend to run against — the token is scoped to your tenant, so threads cannot collide across tenants.

Response

Streaming credential

A short-lived credential for subscribing to a thread's token stream.

token

string

required

Bearer token for the streaming endpoint. Safe to hand to a browser — it grants read access to this one thread and nothing else.

expiresAt

string<date-time>

required

Timestamp when the token stops being accepted.

url

string

required

Fully-resolved SSE endpoint for this thread. Connect here with the token as a Bearer credential.

Example:

"https://stream.promptjuggler.com/stream/0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10"

Create and trigger a workflow runTriggers an asynchronous workflow run with the given inputs and returns a run ID and thread ID. Reference the workflow by version number, tag, or `__latest__`. Pass a thread ID to continue an existing conversation across runs.

PromptJuggler PHP SDK

$token = $pj->createStreamToken('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10');

const token = await pj.createStreamToken('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10');

token = pj.create_stream_token('0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10')

StreamTokenResponse token = pj.createStreamToken("0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10");

token, err := pj.CreateStreamToken(ctx, "0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10")

curl --request POST \
  --url https://promptjuggler.com/api/v1/threads/{thread}/stream-token \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://promptjuggler.com/api/v1/threads/{thread}/stream-token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://promptjuggler.com/api/v1/threads/{thread}/stream-token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "token": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "url": "https://stream.promptjuggler.com/stream/0198f0e2-9c3a-7c1d-8f4b-2a6d5e7c9b10"
}

{
  "error": "<string>"
}

Getting Started

Core Concepts

Workflow Nodes

Tools

Guides

SDKs

API Reference

Create a streaming credential for a thread

Authorizations

Path Parameters

Response