Skip to content
Dashboard

Pause task

client.agent.tasks.pause(stringid, RequestOptionsoptions?): TaskPauseResponse { status }
POST/agent/tasks/{id}/pause

Pauses a running agent task.

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
TaskPauseResponse { status }
status?: string

Pause task

import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.pause('id');

console.log(response.status);
{
  "status": "status"
}
Returns Examples
{
  "status": "status"
}