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();
{
  "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": {},
  "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>"
}

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
​
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
​
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
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