List an agent's scheduled prompts

List an agent's schedules

curl --request GET \
  --url https://api.onecli.sh/v1/agents/{agentId}/crons \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/v1/agents/{agentId}/crons', 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.onecli.sh/v1/agents/{agentId}/crons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/agents/{agentId}/crons"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/crons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "crons": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "schedule": "<string>",
      "timezone": "<string>",
      "enabled": true,
      "disabledReason": "authorization",
      "nextFireAt": "2023-11-07T05:31:56Z",
      "lastFiredAt": "2023-11-07T05:31:56Z",
      "lastOutcome": "ok",
      "consecutiveFailures": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

agents

{agentId}

crons

List an agent's schedules

curl --request GET \
  --url https://api.onecli.sh/v1/agents/{agentId}/crons \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/v1/agents/{agentId}/crons', 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.onecli.sh/v1/agents/{agentId}/crons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/agents/{agentId}/crons"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/crons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "crons": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "schedule": "<string>",
      "timezone": "<string>",
      "enabled": true,
      "disabledReason": "authorization",
      "nextFireAt": "2023-11-07T05:31:56Z",
      "lastFiredAt": "2023-11-07T05:31:56Z",
      "lastOutcome": "ok",
      "consecutiveFailures": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Returns the schedules on one hosted agent. Use it to audit what an agent runs on its own and when it runs next. Related guide: Agent access: grant credentials to agents. Hosted agents only.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

agentId

string

required

Response

Schedules

crons

object[]

Show child attributes

Workspace

Organization

Enterprise

Platform

List an agent's scheduled prompts

Authorizations

Path Parameters

Response