GET
/
v1
/
teams
/
{teamId}
/
agents
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.agents.listAgents({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "currentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currentVersion": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 123,
        "instructions": "<string>",
        "model": "<string>",
        "webSearch": true,
        "toolPolicy": {
          "allow": [
            "<string>"
          ],
          "deny": [
            "<string>"
          ]
        },
        "mediaPolicy": {
          "cta": {
            "mode": "none"
          },
          "forbidStock": true,
          "polishIterations": 2,
          "ctaEndSlide": true
        },
        "skillIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "mcpServerIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "toolIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "perRunCreditCeilingDecimillicents": 1,
        "brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "maxRunMinutes": 180,
        "outputContract": {
          "mode": "text"
        },
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "<string>",
        "maxPostsPerRun": 50
      },
      "archivedAt": "<string>",
      "isDefault": true,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "lastRun": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "<string>"
      },
      "warnings": [
        "<string>"
      ]
    }
  ]
}

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.

Response

ListAgentsResponse

data
object[]
required