TypeScript client

import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.agents.batchAgents({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": {
        "message": "<string>",
        "code": "<string>"
      }
    }
  ],
  "outcome": {
    "totalCount": 123,
    "successCount": 123,
    "failureCount": 123,
    "appliedCount": 123,
    "noopCount": 123
  }
}

Agents

Batch agents

Archive many managed agents at once, exactly as deleteAgent archives one: archived agents cannot run or be edited and stay readable by id. The bundled General and Slideshow agents are refused with CONFLICT. Permission is checked once for the batch (the same permission as the single delete); a 403 fails the whole call. Then every id is processed in ONE transaction and the call returns HTTP 200 with one result per id, in request order: applied (removed by this call), noop (already removed) or failed (left unchanged, with error.code NOT_FOUND for an id outside this team or CONFLICT for a row a business rule protects), plus outcome counts. Read each item rather than the HTTP status. At most 100 unique ids per call.

POST

teams

{teamId}

agents

batch

TypeScript client

import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.agents.batchAgents({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": {
        "message": "<string>",
        "code": "<string>"
      }
    }
  ],
  "outcome": {
    "totalCount": 123,
    "successCount": 123,
    "failureCount": 123,
    "appliedCount": 123,
    "noopCount": 123
  }
}

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.

Body

application/json

action

enum<string>

required

The action applied to every listed id. delete removes each row exactly as the single delete endpoint does.

Available options:

delete

ids

string<uuid>[]

required

an array of at most 100 item(s)

Required array length: 1 - 100 elements

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}$

Response

WorkspaceBatchResponse

data

object[]

required

One result per requested id, in request order.

Show child attributes

outcome

object

required

Show child attributes

Agent activity summary Agent content stats