Create Cron

Create a cron to schedule runs on new threads.

POST /runs/crons

Try it

200

{
  "cron_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",
  "payload": {},
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "<string>",
  "next_run_date": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Body

application/json

Payload for creating a stateless cron job (creates a new thread for each execution).

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 · object

Input · object[]

Input · object

metadata · Metadata · object

Metadata to assign to the cron job runs.

config · Config · object

The configuration for the assistant.

Show child attributes

config. tags · string[]

config. recursion_limit · integer

config. configurable · Configurable · object

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

interrupt_before

Nodes to interrupt immediately before they get executed.

Available options: *

interrupt_after

Nodes to interrupt immediately after they get executed.

Available options: *

on_run_completed · enum<string> · default: delete

What to do with the thread after the run completes. 'delete' removes the thread after execution. 'keep' creates a new thread for each execution but does not clean them up.

Available options: delete, keep

Response

200

application/json

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 · 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 · Metadata · object

The cron metadata.