Skip to main content
GET
Typescript (SDK)

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")

Response

Task details

id
string
required
object
string
required
name
string
required
description
string | null
required
kind
enum<string>
required
Available options:
agent,
script
prompt
string | null
required
success_criteria
string | null
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
pre_run_script
string | null
required
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
visibility
enum<string>
required
Available options:
account,
personal
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
max_runs_per_day
integer | null
required

Event tasks: the most event-started runs per day (account time zone); later events are skipped as rate_limited.

min_interval_seconds
integer | null
required

Event tasks: the cooldown after an event-started run; events inside it are skipped as rate_limited.

slack_sender_name
string | null
required

The name Slack shows on this task's posted results. Null posts as the task's bot, else Crevio.

site_id
string | null
required
source
enum<string>
required

How the task came to exist: user (a person made it in the dashboard), agent (the agent made it inside the chat origin_chat_id, whose person is created_by_id), or system (a built-in task).

Available options:
user,
agent,
system
created_by_id
string | null
required

The person (user_...) who made the task or asked for it. Null for built-in tasks.

created_by_name
string | null
required
origin_chat_id
string | null
required

The chat (aichat_...) the task was set up in. A member's chat opens only for that member.

recent_runs
object[]
required

The task's newest executed runs (at most 5, newest first; skipped and test runs excluded).