Run a scheduled Task

Starts one repeating or cronOneOff Task immediately or when due. A 202 response means the run was accepted, not completed.

OpenAPI

````yaml post /api/v2/tasks/{taskId}/run
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/tasks/{taskId}/run:
post:
tags:
- Tasks
summary: Run a scheduled Task
description: >-
Starts one repeating or cronOneOff Task immediately or when due. A 202
response means the run was accepted, not completed.
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task ID
- name: targetAccountId
description: Require the Task to belong to this agent account in the organization
in: query
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
properties:
mode:
type: string
enum:
- force
- due
default: force
responses:
'202':
description: Task run accepted
'400':
description: Invalid run mode
'401':
description: Unauthorized
'403':
description: Target account is outside the organization
'404':
description: Task not found in the selected account scope
'409':
description: Task cannot be run
'500':
description: Internal Server Error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token

````