Create Run Batch
curl --request POST \
--url https://api.example.com/runs/batch \
--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"
}
]
'import requests
url = "https://api.example.com/runs/batch"
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"
}
]
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'
}
])
};
fetch('https://api.example.com/runs/batch', 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/batch",
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'
]
]),
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/batch"
payload := strings.NewReader("[\n {\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 }\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/batch")
.header("Content-Type", "application/json")
.body("[\n {\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 }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/runs/batch")
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 {\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 }\n]"
response = http.request(request)
puts response.read_body{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Create Run Batch
Create a batch of runs and return immediately.
POST
/
runs
/
batch
Create Run Batch
curl --request POST \
--url https://api.example.com/runs/batch \
--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"
}
]
'import requests
url = "https://api.example.com/runs/batch"
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"
}
]
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'
}
])
};
fetch('https://api.example.com/runs/batch', 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/batch",
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'
]
]),
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/batch"
payload := strings.NewReader("[\n {\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 }\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/batch")
.header("Content-Type", "application/json")
.body("[\n {\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 }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/runs/batch")
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 {\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 }\n]"
response = http.request(request)
puts response.read_body{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
application/json
Minimum array length:
1The assistant ID or graph name to run. If using graph name, will default to first assistant created from that graph.
The input to the graph.
The command to run.
Show child attributes
Show child attributes
Metadata to assign to the run.
The configuration for the assistant.
Show child attributes
Show child attributes
Static context added to the assistant.
Webhook to call after LangGraph API call is done.
Required string length:
1 - 65536The stream mode(s) to use.
Available options:
values, messages, messages-tuple, tasks, checkpoints, updates, events, debug, custom 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.
Whether to stream output from subgraphs.
Whether to persist the stream chunks in order to resume the stream later.
Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.
Available options:
delete, keep The number of seconds to wait before starting the run. Use to schedule future runs.
Whether to checkpoint during the run.
Deprecated. Use durability instead to control checkpoint persistence behavior during the run.
Durability level for the run. Must be one of sync, async, or exit. See durability modes for more details.
Available options:
sync, async, exit Response
Success
Was this page helpful?