Create a hosted schedule

curl --request POST \
  --url https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cron": "<string>",
  "message": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules"

payload = {
    "cron": "<string>",
    "message": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cron: '<string>', message: '<string>', timezone: '<string>'})
};

fetch('https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules', 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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules",
  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([
    'cron' => '<string>',
    'message' => '<string>',
    'timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules"

	payload := strings.NewReader("{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "description": "<string>",
  "etag": "<string>",
  "fleet_id": "<string>",
  "message": "<string>",
  "once": true,
  "run_state": "scheduled",
  "schedule_id": "<string>",
  "source": "<string>",
  "status": "<string>",
  "sync": "<string>",
  "timezone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_error": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z",
  "override": {
    "cron": null,
    "message": null,
    "status": "active",
    "timezone": null
  }
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

POST

workspaces

{workspace_id}

fleets

{fleet_id}

schedules

Create a hosted schedule

curl --request POST \
  --url https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cron": "<string>",
  "message": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules"

payload = {
    "cron": "<string>",
    "message": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cron: '<string>', message: '<string>', timezone: '<string>'})
};

fetch('https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules', 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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules",
  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([
    'cron' => '<string>',
    'message' => '<string>',
    'timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules"

	payload := strings.NewReader("{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentsfleet.net/v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cron\": \"<string>\",\n  \"message\": \"<string>\",\n  \"timezone\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "description": "<string>",
  "etag": "<string>",
  "fleet_id": "<string>",
  "message": "<string>",
  "once": true,
  "run_state": "scheduled",
  "schedule_id": "<string>",
  "source": "<string>",
  "status": "<string>",
  "sync": "<string>",
  "timezone": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_error": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z",
  "override": {
    "cron": null,
    "message": null,
    "status": "active",
    "timezone": null
  }
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "outcome": "<string>",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolved_by": "<string>",
  "user_message": "<string>"
}

Authorizations

Authorization

string

header

required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id

string

required

Workspace identifier (version 7 universally unique identifier, or UUID).

fleet_id

string

required

Fleet identifier (version 7 universally unique identifier, or UUID).

Body

application/json

What a caller sends to create a schedule.

cron

string

required

The expression it fires on.

message

string

required

What the fleet is asked to do when it fires.

timezone

string | null

The zone that expression is read in. Absent means UTC.

Response

Saved schedule with its registration status

One schedule, as the tenant surface renders it.

created_at

string<date-time>

required

When it was created.

cron

string

required

The expression it fires on.

description

string

required

The expression in words, with the zone it is read in, for example At 9:00 AM (Asia/Kolkata).

etag

string

required

Current ETag covering the selected recipe, setup, and instance overrides.

fleet_id

string

required

The fleet it wakes.

message

string

required

What the fleet is asked to do.

once

boolean

required

Whether it retires after its first fire. Beta: this field may change shape before it is stable.

run_state

enum<string>

required

Whether the schedule will run, as the server reads it now.

Available options:

scheduled,

paused,

activation_pending,

next_run_unavailable

schedule_id

string

required

Its identity.

source

string

required

Who made it: api for a person, trigger for the fleet's own document, fleet for the fleet while it ran. Only a fleet schedule can be changed by the fleet. Beta: this field may change shape before it is stable.

status

string

required

What the operator wants it to be doing.

sync

string

required

How far agentsfleet has brought the external scheduler in line.

A schedule can save without registering. This field shows you that state.

timezone

string

required

The zone that expression is read in.

updated_at

string<date-time>

required

When it was last changed.

last_error

string | null

Why the last push failed, when one did.

next_run_at

string<date-time> | null

When it next runs, computed by the server from the expression and its zone. Null unless run_state is scheduled.

override

object | null

Explicit instance overlay, omitted when the pinned recipe is inherited.

Show child attributes

Overview

Health

Authentication

API keys

Users

Account management

Model provider credentials

Balance and usage

Account models

Runner administration

Runner API

Model catalog

Workspaces

Private setup chats

Workspace preferences

Secrets

Connectors

Approvals

Fleets

Fleet library

Fleet messages

Fleet memories

Fleet schedules

Fleet events

Integration grants

Webhooks

Platform administration

Create a hosted schedule

Authorizations

Path Parameters

Body

Response