Skip to main content
POST
/
threads
/
{thread_id}
/
runs
/
crons
{
  "cron_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_time": "2023-11-07T05:31:56Z",
  "schedule": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "payload": {},
  "next_run_date": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Path Parameters

​
thread_id
string<uuid>
required

The ID of the thread.

Body

application/json

Payload for creating a thread-specific cron job (runs on the same thread).

​
schedule
string
required

The cron schedule to execute this job on.

​
assistant_id
required

The assistant ID or graph name to run. If using graph name, will default to the assistant automatically created from that graph by the server.

​
end_time
string<date-time>

The end date to stop running the cron.

​
input

The input to the graph.

​
metadata
object

Metadata to assign to the cron job runs.

​
config
object

The configuration for the assistant.

​
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
​
interrupt_before

Nodes to interrupt immediately before they get executed.

Available options:
*
​
interrupt_after

Nodes to interrupt immediately after they get executed.

Available options:
*
​
multitask_strategy
enum<string>
default:enqueue

Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.

Available options:
reject,
rollback,
interrupt,
enqueue

Response

Success

Represents a scheduled task.

​
cron_id
string<uuid>
required

The ID of the cron.

​
thread_id
string<uuid>
required

The ID of the thread.

​
end_time
string<date-time>
required

The end date to stop running the cron.

​
schedule
string
required

The schedule to run, cron format.

​
created_at
string<date-time>
required

The time the cron was created.

​
updated_at
string<date-time>
required

The last time the cron was updated.

​
payload
object
required

The run payload to use for creating new run.

​
assistant_id
string<uuid> | null

The ID of the assistant.

​
user_id
string | null

The ID of the user.

​
next_run_date
string<date-time> | null

The next run date of the cron.

​
metadata
object

The cron metadata.