Sign in

v1

latestOpenAPI 3.1.02026-07-22152755.8 KB
schedules

Retrieve a scheduled job by id

get/schedules/v1/cron-jobs/{id}/

Path parameters

idinteger required

A unique integer value identifying this cron job.

Response

idinteger
agentinteger

Agent ID for the cron job Example: 123

namestring

Name for the cronjob

crontab_expressionstring required

Crontab expression for the cron job Example:

  • "0 9 * * 1-5"
  • "0 0 * * 0"
timezonestring

Timezone for the cron job Example: "America/Los_Angeles"

{"stackTrail":"components:schemas:CronJob:properties:scenarios","oasType":"schema","type":"unknown","description":"\nList of scenario IDs for the cron job\nExample: `[123, 456, 789]`\n"}
scenario_idsinteger[]

List of scenario IDs for the cron job Example: [123, 456, 789]

personalityinteger nullable

(Deprecated) Use personalities field instead. Example: 1 (personality ID)

personalitiesinteger[]

List of personalities to use for test execution. Multiple personalities can be assigned to run tests with different configurations. Example: [1, 2, 3] (personality IDs)

tagsstring[]

List of tags for the cron job Example: ["tag1", "tag2", "tag3"]

frequencyinteger

Frequency for the cron job Example: 1

concurrency_limitinteger nullable

Max number of parallel conversations to run per execution. Leave unset for no cap (uses default capacity). Example: 3

run_as_textboolean

DEPRECATED: Use execution_mode instead. Kept for backward compatibility. Run the cron job as text Example: true or false

execution_mode'voice' | 'text' | 'sip' | 'vapi_webrtc' | 'retell_webrtc' | 'elevenlabs' | 'ello' | 'livekit_v2' | 'pipecat_v2' | 'agora'

Execution mode for the cron job Choices: voice, text, sip, vapi_webrtc, elevenlabs, pipecat_v2, livekit_v2, retell_webrtc, ello, agora Example: "voice", "text", "sip", "pipecat_v2", "elevenlabs", or "livekit_v2"

  • voice - Voice
  • text - Text
  • sip - SIP
  • vapi_webrtc - VAPI WebRTC
  • retell_webrtc - Retell WebRTC
  • elevenlabs - ElevenLabs
  • ello - Ello
  • livekit_v2 - LiveKit
  • pipecat_v2 - Pipecat
  • agora - Agora
notify_on'never' | 'success' | 'failure' | 'both'

Select when to notify

  • never - Never
  • success - Success
  • failure - Failure
  • both - Both
is_activeboolean
created_byinteger
created_via'user' | 'api' | 'mcp' | 'cli' | 'sdk' | 'null' nullable

How the cron job was created: user (UI), api (API key), or mcp (MCP client)

  • user - User
  • api - API
  • mcp - MCP
  • cli - CLI
  • sdk - SDK
created_atstring date-time

Timestamp when the cron job was created Example: 2021-01-01 00:00:00

updated_atstring date-time

Timestamp when the cron job was last updated Example: 2021-01-01 00:00:00