Pause agent run - Octospark

import { OctosparkClient } from '@octospark/sdk' const client = new OctosparkClient({ token: process.env.OCTOSPARK_TOKEN }) const response = await client.agents.pauseAgentRun({ teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId", agentId: process.env.OCTOSPARK_AGENT_ID ?? "agentId", runId: process.env.OCTOSPARK_RUN_ID ?? "runId", })

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId

string

required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

agentId

string

required

Managed agent id (UUID), as returned by the list/create agents endpoints.

runId

string

required

Agent run id (UUID), as returned by the start/list runs endpoints.

Response

PauseAgentRunResponse

runId

string<uuid>

required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status

enum<string>

required

The run status when the request was recorded; a running run pauses at its next step boundary.

Available options:

queued,

running,

paused,

succeeded,

failed,

cancelled

pauseRequested

boolean

required

True when a pause was newly requested; false when the run was already paused.