Skip to main content
POST
/
runs
/
crons
/
search
[
  {
    "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": {}
  }
]

Body

application/json

Payload for listing crons

​
assistant_id
string<uuid>

The assistant ID or graph name to filter by using exact match.

​
thread_id
string<uuid>

The thread ID to search for.

​
limit
integer
default:10

The maximum number of results to return.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

The number of results to skip.

Required range: x >= 0
​
sort_by
enum<string>
default:created_at

The field to sort by.

Available options:
cron_id,
assistant_id,
thread_id,
next_run_date,
end_time,
created_at,
updated_at
​
sort_order
enum<string>
default:desc

The order to sort by.

Available options:
asc,
desc
​
select
enum<string>[]

Specify which fields to return. If not provided, all fields are returned.

Response

Success

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