Create an agent

curl --request POST \
  --url https://api.endclose.com/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "description": "<string>",
  "model": "<string>",
  "cadence": "manual",
  "hour": 11,
  "minute": 29,
  "day_of_week": 3,
  "timezone": "UTC",
  "active": true,
  "handles_file_drops": false,
  "delivery_enabled": false,
  "delivery_recipients": [
    "jsmith@example.com"
  ],
  "delivery_file_pattern": "*.csv",
  "mentions": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ]
}
'

import requests

url = "https://api.endclose.com/v1/agents"

payload = {
    "name": "<string>",
    "instructions": "<string>",
    "description": "<string>",
    "model": "<string>",
    "cadence": "manual",
    "hour": 11,
    "minute": 29,
    "day_of_week": 3,
    "timezone": "UTC",
    "active": True,
    "handles_file_drops": False,
    "delivery_enabled": False,
    "delivery_recipients": ["jsmith@example.com"],
    "delivery_file_pattern": "*.csv",
    "mentions": [
        {
            "id": "<string>",
            "label": "<string>"
        }
    ]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    instructions: '<string>',
    description: '<string>',
    model: '<string>',
    cadence: 'manual',
    hour: 11,
    minute: 29,
    day_of_week: 3,
    timezone: 'UTC',
    active: true,
    handles_file_drops: false,
    delivery_enabled: false,
    delivery_recipients: ['jsmith@example.com'],
    delivery_file_pattern: '*.csv',
    mentions: [{id: '<string>', label: '<string>'}]
  })
};

fetch('https://api.endclose.com/v1/agents', 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.endclose.com/v1/agents",
  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([
    'name' => '<string>',
    'instructions' => '<string>',
    'description' => '<string>',
    'model' => '<string>',
    'cadence' => 'manual',
    'hour' => 11,
    'minute' => 29,
    'day_of_week' => 3,
    'timezone' => 'UTC',
    'active' => true,
    'handles_file_drops' => false,
    'delivery_enabled' => false,
    'delivery_recipients' => [
        'jsmith@example.com'
    ],
    'delivery_file_pattern' => '*.csv',
    'mentions' => [
        [
                'id' => '<string>',
                'label' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.endclose.com/v1/agents"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.endclose.com/v1/agents")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.endclose.com/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}"

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

{
  "name": "<string>",
  "instructions": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "mentions": [
    {
      "type": "reconciliation",
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "model": "<string>",
  "cadence": "manual",
  "hour": 11,
  "minute": 29,
  "day_of_week": 3,
  "timezone": "UTC",
  "active": true,
  "handles_file_drops": true,
  "delivery_enabled": true,
  "delivery_recipients": [
    "jsmith@example.com"
  ],
  "delivery_file_pattern": "*.csv",
  "input_files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "byte_size": 123,
      "content_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "url": "<string>"
    }
  ],
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

POST

agents

Create an agent

curl --request POST \
  --url https://api.endclose.com/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "description": "<string>",
  "model": "<string>",
  "cadence": "manual",
  "hour": 11,
  "minute": 29,
  "day_of_week": 3,
  "timezone": "UTC",
  "active": true,
  "handles_file_drops": false,
  "delivery_enabled": false,
  "delivery_recipients": [
    "jsmith@example.com"
  ],
  "delivery_file_pattern": "*.csv",
  "mentions": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ]
}
'

import requests

url = "https://api.endclose.com/v1/agents"

payload = {
    "name": "<string>",
    "instructions": "<string>",
    "description": "<string>",
    "model": "<string>",
    "cadence": "manual",
    "hour": 11,
    "minute": 29,
    "day_of_week": 3,
    "timezone": "UTC",
    "active": True,
    "handles_file_drops": False,
    "delivery_enabled": False,
    "delivery_recipients": ["jsmith@example.com"],
    "delivery_file_pattern": "*.csv",
    "mentions": [
        {
            "id": "<string>",
            "label": "<string>"
        }
    ]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    instructions: '<string>',
    description: '<string>',
    model: '<string>',
    cadence: 'manual',
    hour: 11,
    minute: 29,
    day_of_week: 3,
    timezone: 'UTC',
    active: true,
    handles_file_drops: false,
    delivery_enabled: false,
    delivery_recipients: ['jsmith@example.com'],
    delivery_file_pattern: '*.csv',
    mentions: [{id: '<string>', label: '<string>'}]
  })
};

fetch('https://api.endclose.com/v1/agents', 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.endclose.com/v1/agents",
  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([
    'name' => '<string>',
    'instructions' => '<string>',
    'description' => '<string>',
    'model' => '<string>',
    'cadence' => 'manual',
    'hour' => 11,
    'minute' => 29,
    'day_of_week' => 3,
    'timezone' => 'UTC',
    'active' => true,
    'handles_file_drops' => false,
    'delivery_enabled' => false,
    'delivery_recipients' => [
        'jsmith@example.com'
    ],
    'delivery_file_pattern' => '*.csv',
    'mentions' => [
        [
                'id' => '<string>',
                'label' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.endclose.com/v1/agents"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.endclose.com/v1/agents")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.endclose.com/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"description\": \"<string>\",\n  \"model\": \"<string>\",\n  \"cadence\": \"manual\",\n  \"hour\": 11,\n  \"minute\": 29,\n  \"day_of_week\": 3,\n  \"timezone\": \"UTC\",\n  \"active\": true,\n  \"handles_file_drops\": false,\n  \"delivery_enabled\": false,\n  \"delivery_recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"delivery_file_pattern\": \"*.csv\",\n  \"mentions\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ]\n}"

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

{
  "name": "<string>",
  "instructions": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "mentions": [
    {
      "type": "reconciliation",
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "model": "<string>",
  "cadence": "manual",
  "hour": 11,
  "minute": 29,
  "day_of_week": 3,
  "timezone": "UTC",
  "active": true,
  "handles_file_drops": true,
  "delivery_enabled": true,
  "delivery_recipients": [
    "jsmith@example.com"
  ],
  "delivery_file_pattern": "*.csv",
  "input_files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "byte_size": 123,
      "content_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "url": "<string>"
    }
  ],
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

name

string

required

Unique within the environment

instructions

string

required

The standing prompt every run executes

description

string

model

string

Explicit model override. Omit to follow the platform default.

cadence

enum<string>

default:manual

Available options:

manual,

hourly,

daily,

weekdays,

weekly

hour

integer

Required range: 0 <= x <= 23

minute

integer

Required range: 0 <= x <= 59

day_of_week

integer

0 = Sunday

Required range: 0 <= x <= 6

timezone

string

default:UTC

IANA timezone the schedule is evaluated in

active

boolean

default:true

handles_file_drops

boolean

default:false

At most one active agent per environment can have this enabled

delivery_enabled

boolean

default:false

delivery_recipients

string<email>[]

delivery_file_pattern

string

default:*.csv

mentions

object[]

Show child attributes

Response

Agent created

An agent: standing instructions executed in an isolated sandbox with access to the environment's data, on a schedule or on demand. The same objects the app's Agents page manages.

name

string

required

Unique within the environment

instructions

string

required

The standing prompt every run executes

string<uuid>

description

string | null

mentions

object[]

Reconciliations, data streams, users, and other agents whose context is resolved into every run's prompt. Mentioning an agent also teaches the run how to trigger it (see POST /agents/{id}/runs)

Show child attributes

model

string

The model the agent runs on — resolved to the platform default when not set explicitly

cadence

enum<string>

manual agents only run when triggered (POST /agents/{id}/runs)

Available options:

manual,

hourly,

daily,

weekdays,

weekly

hour

integer | null

Required for daily, weekdays, and weekly cadences

Required range: 0 <= x <= 23

minute

integer | null

Required for every cadence except manual

Required range: 0 <= x <= 59

day_of_week

integer | null

0 = Sunday. Required for weekly cadence

Required range: 0 <= x <= 6

timezone

string

default:UTC

IANA timezone the schedule is evaluated in

active

boolean

Inactive agents are never scheduled but can still be run on demand

handles_file_drops

boolean

Whether this agent processes files dropped in the app. At most one active agent per environment can have this enabled.

delivery_enabled

boolean

Email output files matching delivery_file_pattern to delivery_recipients after each completed run

delivery_recipients

string<email>[]

delivery_file_pattern

string

default:*.csv

Case-insensitive glob selecting which output files are delivered

input_files

object[]

Show child attributes

next_run_at

string<date-time> | null

last_run_at

string<date-time> | null

created_at

string<date-time>

updated_at

string<date-time>

Resources

Webhooks

Create an agent

Authorizations

Body

Response