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": 123,
  "cron": "<string>",
  "fleet_id": "<string>",
  "message": "<string>",
  "schedule_id": "<string>",
  "status": "<string>",
  "sync": "<string>",
  "timezone": "<string>",
  "updated_at": 123,
  "last_error": "<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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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": 123,
  "cron": "<string>",
  "fleet_id": "<string>",
  "message": "<string>",
  "schedule_id": "<string>",
  "status": "<string>",
  "sync": "<string>",
  "timezone": "<string>",
  "updated_at": 123,
  "last_error": "<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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "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>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

Authorizations

Authorization

string

header

required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

workspace_id

string

required

UUIDv7 of the workspace.

fleet_id

string

required

UUIDv7 of the fleet.

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

The schedule as reconciled with the scheduler

One schedule, as the tenant surface renders it.

created_at

integer<int64>

required

When it was created.

cron

string

required

The expression it fires on.

fleet_id

string

required

The fleet it wakes.

message

string

required

What the fleet is asked to do.

schedule_id

string

required

Its identity.

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

integer<int64>

required

When it was last changed.

last_error

string | null

Why the last push failed, when one did.

Overview

Health

Authentication

API keys

Tenants

Tenant provider

Tenant balance

Tenant models

Fleet

Runner plane

Model Library

Workspaces

Workspace preferences

Secrets

Connectors

Approvals

Fleets

Fleet library

Fleet messages

Fleet memories

Fleet schedules

Fleet events

Integration grants

Webhooks

Admin

Create a hosted schedule

Authorizations

Path Parameters

Body

Response