Skip to main content
PATCH
/
tasks
/
{id}
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.tasks.update({
    id: "<id>",
    aiTaskRequest: {},
  });

  console.log(result);
}

run();
curl --request PATCH \
  --url https://api.crevio.co/v1/tasks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "cron_expression": "<string>",
  "interval_seconds": 123,
  "scheduled_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "model_id": "<string>",
  "condition_script": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "active": true,
  "delivery_methods": [],
  "event_conditions": {},
  "site_id": "<string>"
}
'
import requests

url = "https://api.crevio.co/v1/tasks/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "prompt": "<string>",
    "cron_expression": "<string>",
    "interval_seconds": 123,
    "scheduled_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "model_id": "<string>",
    "condition_script": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "active": True,
    "delivery_methods": [],
    "event_conditions": {},
    "site_id": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    prompt: '<string>',
    cron_expression: '<string>',
    interval_seconds: 123,
    scheduled_at: '2023-11-07T05:31:56Z',
    timezone: '<string>',
    model_id: '<string>',
    condition_script: '<string>',
    expires_at: '2023-11-07T05:31:56Z',
    active: true,
    delivery_methods: [],
    event_conditions: {},
    site_id: '<string>'
  })
};

fetch('https://api.crevio.co/v1/tasks/{id}', 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.crevio.co/v1/tasks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'prompt' => '<string>',
    'cron_expression' => '<string>',
    'interval_seconds' => 123,
    'scheduled_at' => '2023-11-07T05:31:56Z',
    'timezone' => '<string>',
    'model_id' => '<string>',
    'condition_script' => '<string>',
    'expires_at' => '2023-11-07T05:31:56Z',
    'active' => true,
    'delivery_methods' => [
        
    ],
    'event_conditions' => [
        
    ],
    'site_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.crevio.co/v1/tasks/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_expression\": \"<string>\",\n  \"interval_seconds\": 123,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"model_id\": \"<string>\",\n  \"condition_script\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"active\": true,\n  \"delivery_methods\": [],\n  \"event_conditions\": {},\n  \"site_id\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.crevio.co/v1/tasks/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_expression\": \"<string>\",\n  \"interval_seconds\": 123,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"model_id\": \"<string>\",\n  \"condition_script\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"active\": true,\n  \"delivery_methods\": [],\n  \"event_conditions\": {},\n  \"site_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/tasks/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_expression\": \"<string>\",\n  \"interval_seconds\": 123,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"model_id\": \"<string>\",\n  \"condition_script\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"active\": true,\n  \"delivery_methods\": [],\n  \"event_conditions\": {},\n  \"site_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "cron_expression": "<string>",
  "interval_seconds": 123,
  "scheduled_at": "2023-11-07T05:31:56Z",
  "event_conditions": {},
  "condition_script": "<string>",
  "timezone": "<string>",
  "delivery_methods": [],
  "model_id": "<string>",
  "active": true,
  "expires_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "total_runs_count": 123,
  "consecutive_failure_count": 123,
  "total_credits_consumed": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "site_id": "<string>"
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_missing",
    "message": "The requested resource was not found"
  }
}
{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

​
Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

​
id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Body

application/json
​
name
string
​
description
string | null
​
prompt
string
​
trigger_type
enum<string>
Available options:
immediate,
cron,
interval,
once,
event
​
cron_expression
string | null
​
interval_seconds
integer | null
​
scheduled_at
string<date-time> | null
​
timezone
string
​
model_id
string | null
​
agent
enum<string>

Which agent runs the task. Use engineering for pure code/build work on a site; defaults to business.

Available options:
business,
engineering
​
condition_script
string | null

Cheap pre-run gate for recurring tasks (cron/interval). Plain JavaScript run in a dynamic Worker isolate against the same crevioApi.* connector as the execute tool, BEFORE each scheduled run — no LLM, no credits. The task only runs when the script's last expression (or explicit return) is truthy; it skips on false/null. Default to setting this whenever the task is "act only when X" (new/unfulfilled/failed records, a threshold crossed, an unread inbox, a metric at zero) — without it the agent wakes and spends credits on every tick even when there's nothing to do. Only omit it for tasks that genuinely should run every tick (e.g. a scheduled report the user always wants). End with a boolean, e.g. const r = await crevioApi.listOrders({ status: 'succeeded' }); r.data.some(o => o.fulfillment_status !== 'fulfilled'). Errors fail open (the task runs). Ignored for non-recurring triggers.

​
approval_mode
enum<string>
Available options:
autonomous,
supervised,
read_only
​
expires_at
string<date-time> | null
​
active
boolean
​
delivery_methods
enum<string>[]
Available options:
notification,
email,
telegram,
discord,
slack
​
event_conditions
object | null
​
site_id
string

Site this task works on (site_...); its repo is mounted as the run's workspace. Defaults to the account's default working site.

Response

Task updated

​
id
string
required
​
object
string
required
​
name
string
required
​
description
string | null
required
​
prompt
string
required
​
trigger_type
enum<string>
required
Available options:
immediate,
cron,
interval,
once,
event
​
cron_expression
string | null
required
​
interval_seconds
integer | null
required
​
scheduled_at
string<date-time> | null
required
​
event_conditions
object | null
required
​
condition_script
string | null
required
​
timezone
string
required
​
delivery_methods
enum<string>[]
required
Available options:
notification,
email,
telegram,
discord,
slack
​
approval_mode
enum<string>
required
Available options:
autonomous,
supervised,
read_only
​
model_id
string | null
required
​
agent
enum<string>
required
Available options:
business,
engineering
​
active
boolean
required
​
expires_at
string<date-time> | null
required
​
next_run_at
string<date-time> | null
required
​
last_run_at
string<date-time> | null
required
​
total_runs_count
integer
required
​
consecutive_failure_count
integer
required
​
total_credits_consumed
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
site_id
string | null
required