Skip to main content
POST
/
runs
/
crons
/
search
Search Crons
curl --request POST \
  --url https://api.example.com/runs/crons/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "limit": 10,
  "offset": 0,
  "sort_by": "created_at",
  "sort_order": "desc",
  "select": []
}
'
import requests

url = "https://api.example.com/runs/crons/search"

payload = {
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": True,
    "limit": 10,
    "offset": 0,
    "sort_by": "created_at",
    "sort_order": "desc",
    "select": []
}
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',
    thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enabled: true,
    limit: 10,
    offset: 0,
    sort_by: 'created_at',
    sort_order: 'desc',
    select: []
  })
};

fetch('https://api.example.com/runs/crons/search', 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/crons/search",
  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',
    'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enabled' => true,
    'limit' => 10,
    'offset' => 0,
    'sort_by' => 'created_at',
    'sort_order' => 'desc',
    'select' => [
        
    ]
  ]),
  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/crons/search"

	payload := strings.NewReader("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\n  \"limit\": 10,\n  \"offset\": 0,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"select\": []\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/crons/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\n  \"limit\": 10,\n  \"offset\": 0,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"select\": []\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/runs/crons/search")

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  \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\n  \"limit\": 10,\n  \"offset\": 0,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"select\": []\n}"

response = http.request(request)
puts response.read_body
[
  {
    "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": {},
    "enabled": true,
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "<string>",
    "next_run_date": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
]
{
  "detail": "<string>"
}

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.

enabled
boolean

Filter by enabled status. If not provided, returns both enabled and disabled crons.

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.

Available options:
cron_id,
assistant_id,
thread_id,
on_run_completed,
end_time,
schedule,
timezone,
created_at,
updated_at,
user_id,
payload,
next_run_date,
metadata,
enabled

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

The run payload to use for creating new run.

enabled
boolean
default:true
required

Whether the cron job should be enabled. Disabled crons are not executed.

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.