GET
/
v1
/
teams
/
{teamId}
/
agent-runs
/
{runId}
/
trace
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.agents.getRunTrace({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  runId: process.env.OCTOSPARK_RUN_ID ?? "runId",
})
{
  "artifacts": [
    {
      "postId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>"
    }
  ],
  "rootRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "selectedRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentName": "<string>",
      "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "model": "<string>",
      "chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflowScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pauseReason": "<string>",
      "pauseDetail": "<string>",
      "error": "<string>",
      "createdAt": "<string>",
      "startedAt": "<string>",
      "finishedAt": "<string>",
      "activeMillis": 123,
      "costDecimillicents": 123,
      "historyComplete": true
    }
  ],
  "truncated": true
}

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.

runId
string
required

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

Response

RunTrace

artifacts
object[]
required
rootRunId
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}$
selectedRunId
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}$
runs
object[]
required
truncated
boolean
required