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

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

const response = await client.dreamLoop.getDreamLoopSettings({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
})
{
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "weekday": 3,
  "timezone": "<string>",
  "dailyCapDecimillicents": 123,
  "eligible": true,
  "nextRunAt": "<string>",
  "updatedAt": "<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

DreamLoopSettings

​
teamId
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}$
​
enabled
boolean
required

Whether the team dream loop reflects on its schedule. On by default for teams with managed agents.

​
cadence
enum<string>
required

daily (03:00 team time) or weekly (03:00 on weekday).

Available options:
daily,
weekly
​
weekday
integer | null
required

Day of a weekly dream loop, 0 = Sunday .. 6 = Saturday, in the team timezone.

Required range: 0 <= x <= 6
​
timezone
string
required

The team scheduling timezone the fire time is evaluated in (UTC when the team has none).

​
dailyCapDecimillicents
integer
required

Most the dream loop may spend per UTC day, in decimillicents ($1).

​
eligible
boolean
required

Whether the team has managed agents; the loop only runs for eligible teams.

​
nextRunAt
string | null
required

ISO-8601 time of the next scheduled reflection, ignoring the per-team jitter; null when disabled or not eligible.

​
updatedAt
string | null
required

When a person last changed these settings; null while the defaults apply.