Create Run, Stream Output

curl --request POST \
  --url https://api.example.com/runs/stream \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input": {},
  "command": {
    "update": {},
    "resume": {},
    "goto": {
      "node": "<string>",
      "input": {}
    }
  },
  "metadata": {},
  "config": {
    "tags": [
      "<string>"
    ],
    "recursion_limit": 123,
    "configurable": {}
  },
  "context": {},
  "webhook": "<string>",
  "stream_mode": [
    "values"
  ],
  "feedback_keys": [
    "<string>"
  ],
  "stream_subgraphs": false,
  "stream_resumable": false,
  "on_completion": "delete",
  "after_seconds": 123,
  "checkpoint_during": false,
  "durability": "async",
  "on_disconnect": "continue"
}
'

import requests

url = "https://api.example.com/runs/stream"

payload = {
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input": {},
    "command": {
        "update": {},
        "resume": {},
        "goto": {
            "node": "<string>",
            "input": {}
        }
    },
    "metadata": {},
    "config": {
        "tags": ["<string>"],
        "recursion_limit": 123,
        "configurable": {}
    },
    "context": {},
    "webhook": "<string>",
    "stream_mode": ["values"],
    "feedback_keys": ["<string>"],
    "stream_subgraphs": False,
    "stream_resumable": False,
    "on_completion": "delete",
    "after_seconds": 123,
    "checkpoint_during": False,
    "durability": "async",
    "on_disconnect": "continue"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    input: {},
    command: {update: {}, resume: {}, goto: {node: '<string>', input: {}}},
    metadata: {},
    config: {tags: ['<string>'], recursion_limit: 123, configurable: {}},
    context: {},
    webhook: '<string>',
    stream_mode: ['values'],
    feedback_keys: ['<string>'],
    stream_subgraphs: false,
    stream_resumable: false,
    on_completion: 'delete',
    after_seconds: 123,
    checkpoint_during: false,
    durability: 'async',
    on_disconnect: 'continue'
  })
};

fetch('https://api.example.com/runs/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/runs/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'input' => [
        
    ],
    'command' => [
        'update' => [
                
        ],
        'resume' => [
                
        ],
        'goto' => [
                'node' => '<string>',
                'input' => [
                                
                ]
        ]
    ],
    'metadata' => [
        
    ],
    'config' => [
        'tags' => [
                '<string>'
        ],
        'recursion_limit' => 123,
        'configurable' => [
                
        ]
    ],
    'context' => [
        
    ],
    'webhook' => '<string>',
    'stream_mode' => [
        'values'
    ],
    'feedback_keys' => [
        '<string>'
    ],
    'stream_subgraphs' => false,
    'stream_resumable' => false,
    'on_completion' => 'delete',
    'after_seconds' => 123,
    'checkpoint_during' => false,
    'durability' => 'async',
    'on_disconnect' => 'continue'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/runs/stream"

	payload := strings.NewReader("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/runs/stream")
  .header("Content-Type", "application/json")
  .body("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/runs/stream")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}"

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

<string>

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

runs

stream

Create Run, Stream Output

curl --request POST \
  --url https://api.example.com/runs/stream \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input": {},
  "command": {
    "update": {},
    "resume": {},
    "goto": {
      "node": "<string>",
      "input": {}
    }
  },
  "metadata": {},
  "config": {
    "tags": [
      "<string>"
    ],
    "recursion_limit": 123,
    "configurable": {}
  },
  "context": {},
  "webhook": "<string>",
  "stream_mode": [
    "values"
  ],
  "feedback_keys": [
    "<string>"
  ],
  "stream_subgraphs": false,
  "stream_resumable": false,
  "on_completion": "delete",
  "after_seconds": 123,
  "checkpoint_during": false,
  "durability": "async",
  "on_disconnect": "continue"
}
'

import requests

url = "https://api.example.com/runs/stream"

payload = {
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input": {},
    "command": {
        "update": {},
        "resume": {},
        "goto": {
            "node": "<string>",
            "input": {}
        }
    },
    "metadata": {},
    "config": {
        "tags": ["<string>"],
        "recursion_limit": 123,
        "configurable": {}
    },
    "context": {},
    "webhook": "<string>",
    "stream_mode": ["values"],
    "feedback_keys": ["<string>"],
    "stream_subgraphs": False,
    "stream_resumable": False,
    "on_completion": "delete",
    "after_seconds": 123,
    "checkpoint_during": False,
    "durability": "async",
    "on_disconnect": "continue"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    input: {},
    command: {update: {}, resume: {}, goto: {node: '<string>', input: {}}},
    metadata: {},
    config: {tags: ['<string>'], recursion_limit: 123, configurable: {}},
    context: {},
    webhook: '<string>',
    stream_mode: ['values'],
    feedback_keys: ['<string>'],
    stream_subgraphs: false,
    stream_resumable: false,
    on_completion: 'delete',
    after_seconds: 123,
    checkpoint_during: false,
    durability: 'async',
    on_disconnect: 'continue'
  })
};

fetch('https://api.example.com/runs/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/runs/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'input' => [
        
    ],
    'command' => [
        'update' => [
                
        ],
        'resume' => [
                
        ],
        'goto' => [
                'node' => '<string>',
                'input' => [
                                
                ]
        ]
    ],
    'metadata' => [
        
    ],
    'config' => [
        'tags' => [
                '<string>'
        ],
        'recursion_limit' => 123,
        'configurable' => [
                
        ]
    ],
    'context' => [
        
    ],
    'webhook' => '<string>',
    'stream_mode' => [
        'values'
    ],
    'feedback_keys' => [
        '<string>'
    ],
    'stream_subgraphs' => false,
    'stream_resumable' => false,
    'on_completion' => 'delete',
    'after_seconds' => 123,
    'checkpoint_during' => false,
    'durability' => 'async',
    'on_disconnect' => 'continue'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/runs/stream"

	payload := strings.NewReader("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/runs/stream")
  .header("Content-Type", "application/json")
  .body("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/runs/stream")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input\": {},\n  \"command\": {\n    \"update\": {},\n    \"resume\": {},\n    \"goto\": {\n      \"node\": \"<string>\",\n      \"input\": {}\n    }\n  },\n  \"metadata\": {},\n  \"config\": {\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"recursion_limit\": 123,\n    \"configurable\": {}\n  },\n  \"context\": {},\n  \"webhook\": \"<string>\",\n  \"stream_mode\": [\n    \"values\"\n  ],\n  \"feedback_keys\": [\n    \"<string>\"\n  ],\n  \"stream_subgraphs\": false,\n  \"stream_resumable\": false,\n  \"on_completion\": \"delete\",\n  \"after_seconds\": 123,\n  \"checkpoint_during\": false,\n  \"durability\": \"async\",\n  \"on_disconnect\": \"continue\"\n}"

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

<string>

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Query Parameters

namespace

string[]

A conversation to stream: a |-joined namespace, empty for the main agent (the root graph) or a subagent's, such as tools:<task_id>. The stream keeps that conversation's events without those of the subagents it starts (subgraphs that the tools node runs), but with the lifecycle events of every subagent below it. Repeat it to stream several conversations. Events about the whole run, such as metadata and error, always pass. Events of the events and messages modes (not messages-tuple) carry no namespace, so they stream with the main agent's conversation. Subagent events exist only on runs created with stream_subgraphs, except lifecycle events, which come either way. If not provided, all of the run's events are returned.

Maximum array length: 32

Body

application/json

Payload for creating a run.

assistant_id

required

The assistant ID or graph name to run. If using graph name, will default to first assistant created from that graph.

input

The input to the graph.

command

Command · object | null

The command to run.

Show child attributes

metadata

Metadata · object

Metadata to assign to the run.

config

Config · object

The configuration for the assistant.

Show child attributes

context

Context · object

Static context added to the assistant.

webhook

string<uri-reference>

Webhook to call after LangGraph API call is done.

Required string length: 1 - 65536

stream_mode

The stream mode(s) to use. lifecycle sends lifecycle|<namespace> events when a subagent (a subgraph) starts and ends: {"event": "started" | "completed" | "failed" | "interrupted", "namespace", "tool_call_id"?, "error"?}, with the id of the tool call that started it, with or without stream_subgraphs. tools sends on_tool_start, on_tool_event, on_tool_end and on_tool_error events with toolCallId and name (from langgraph 1.2.19 and @langchain/langgraph 1.6.0; a tool error's text is never sent).

Available options:

values,

messages,

messages-tuple,

tasks,

checkpoints,

updates,

events,

debug,

custom,

tools,

lifecycle

feedback_keys

string[]

Generate pre-signed URLs for assigning feedback keys to the run.

For each key specified, a unique URL will be generated that can be called to assign the feedback key to the run. See LangSmith Feedback for more details.

stream_subgraphs

boolean

default:false

Whether to stream output from subgraphs.

stream_resumable

boolean

default:false

Whether to keep the run's stream events so a client can rejoin the run. Deployments keep every run's events for RESUMABLE_STREAM_TTL_SECONDS (2 minutes by default) regardless of this field. The in-memory runtime (langgraph dev) keeps them only when it is true.

on_completion

enum<string>

default:delete

Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.

Available options:

delete,

keep

after_seconds

number

The number of seconds to wait before starting the run. Use to schedule future runs.

checkpoint_during

boolean

default:false

deprecated

Whether to checkpoint during the run.

Deprecated. Use durability instead to control checkpoint persistence behavior during the run.

durability

enum<string>

default:async

Durability level for the run. Must be one of sync, async, or exit. See durability modes for more details.

Available options:

sync,

async,

exit

on_disconnect

enum<string>

default:continue

The disconnect mode to use. Must be one of 'cancel' or 'continue'.

Available options:

cancel,

continue

Response

Success

The server will send a stream of events in SSE format. The last event is end, with data {"run_id": ..., "status": ...} giving the run's final status: success (also when the run stops at an interrupt), error, timeout, interrupted (the run was cancelled) or, for a stateless run, rollback. A run that was deleted, or rolled back on a thread, has no status left, so its stream ends with its error event instead. If a stream closes with neither, get the run to see how it ended.

Example event:

id: 1

event: message

data: {}

Deployment components

Develop & test

Frameworks and platforms

Reference

Create Run, Stream Output

Query Parameters

Body

Response