Check the Status of your Threads

Setup

To start, we can setup our client with whatever URL you are hosting your graph from:

SDK initialization

First, we need to setup our client so that we can communicate with our hosted graph:

PythonJavascriptCURL

from langgraph_sdk import get_client
client = get_client(url=<DEPLOYMENT_URL>)
# Using the graph deployed with the name "agent"
assistant_id = "agent"
thread = await client.threads.create()

import { Client } from "@langchain/langgraph-sdk";

const client = new Client({ apiUrl: <DEPLOYMENT_URL> });
// Using the graph deployed with the name "agent"
const assistantId = "agent";
const thread = await client.threads.create();

curl --request POST \
  --url <DEPLOYMENT_URL>/threads \
  --header 'Content-Type: application/json' \
  --data '{}'

Find idle threads

We can use the following commands to find threads that are idle, which means that all runs executed on the thread have finished running:

PythonJavascriptCURL

print(await client.threads.search(status="idle",limit=1))

console.log(await client.threads.search({ status: "idle", limit: 1 }));

curl --request POST \  
--url <DEPLOYMENT_URL>/threads/search \
--header 'Content-Type: application/json' \
--data '{"status": "idle", "limit": 1}'

Output:

[{'thread_id': 'cacf79bb-4248-4d01-aabc-938dbd60ed2c',
'created_at': '2024-08-14T17:36:38.921660+00:00',
'updated_at': '2024-08-14T17:36:38.921660+00:00',
'metadata': {'graph_id': 'agent'},
'status': 'idle',
'config': {'configurable': {}}}]

Find interrupted threads

We can use the following commands to find threads that have been interrupted in the middle of a run, which could either mean an error occurred before the run finished or a human-in-the-loop breakpoint was reached and the run is waiting to continue:

PythonJavascriptCURL

print(await client.threads.search(status="interrupted",limit=1))

console.log(await client.threads.search({ status: "interrupted", limit: 1 }));

curl --request POST \  
--url <DEPLOYMENT_URL>/threads/search \
--header 'Content-Type: application/json' \
--data '{"status": "interrupted", "limit": 1}'

Output:

[{'thread_id': '0d282b22-bbd5-4d95-9c61-04dcc2e302a5',
'created_at': '2024-08-14T17:41:50.235455+00:00',
'updated_at': '2024-08-14T17:41:50.235455+00:00',
'metadata': {'graph_id': 'agent'},
'status': 'interrupted',
'config': {'configurable': {}}}]

Find busy threads

We can use the following commands to find threads that are busy, meaning they are currently handling the execution of a run:

PythonJavascriptCURL

print(await client.threads.search(status="busy",limit=1))

console.log(await client.threads.search({ status: "busy", limit: 1 }));

curl --request POST \  
--url <DEPLOYMENT_URL>/threads/search \
--header 'Content-Type: application/json' \
--data '{"status": "busy", "limit": 1}'

Output:

[{'thread_id': '0d282b22-bbd5-4d95-9c61-04dcc2e302a5',
'created_at': '2024-08-14T17:41:50.235455+00:00',
'updated_at': '2024-08-14T17:41:50.235455+00:00',
'metadata': {'graph_id': 'agent'},
'status': 'busy',
'config': {'configurable': {}}}]

Find specific threads

You may also want to check the status of specific threads, which you can do in a few ways:

Find by ID

You can use the get function to find the status of a specific thread, as long as you have the ID saved

PythonJavascriptCURL

print((await client.threads.get(<THREAD_ID>))['status'])

console.log((await client.threads.get(<THREAD_ID>)).status);

curl --request GET \ 
--url <DEPLOYMENT_URL>/threads/<THREAD_ID> \
--header 'Content-Type: application/json' | jq -r '.status'

Output:

'idle'

Find by metadata

The search endpoint for threads also allows you to filter on metadata, which can be helpful if you use metadata to tag threads in order to keep them organized:

PythonJavascriptCURL

print((await client.threads.search(metadata={"foo":"bar"},limit=1))[0]['status'])

console.log((await client.threads.search({ metadata: { "foo": "bar" }, limit: 1 }))[0].status);

curl --request POST \  
--url <DEPLOYMENT_URL>/threads/search \
--header 'Content-Type: application/json' \
--data '{"metadata": {"foo":"bar"}, "limit": 1}' | jq -r '.[0].status'

Output:

'idle'

Comments