authed

See learning settings

Learning's settings: whether it is available and on, how often it runs and in which time zone, the monthly spend cap (owners only), when the next run starts, and whether the latest change has reached the scheduler.

get/api/v1/steep/learning

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/steep/learning
  • Auth
    none declared

Response

Successful Response

availableboolean required

Whether learning can be turned on for this workspace yet.

enabledboolean required

Whether learning runs on its schedule.

cadence'daily' | 'weekly' | 'monthly' required
timezonestring nullable required

The IANA time zone runs are timed in, like Europe/Berlin. Null until learning is first turned on.

monthly_spend_cap_microusdinteger nullable required

The most learning may spend in a calendar month (UTC), counting every learning run's cost whether your balance or your own model key pays. Null means no cap; always null for callers who can't change learning settings, since only owners see spending. In microusd: millionths of a US dollar (1,000,000 = $1.00).

next_run_atstring date-time nullable required

When the next scheduled run starts, give or take an hour. Null while learning is off or can't run yet.

schedule_in_syncboolean required

False while a saved change is still reaching the scheduler.

first_run_pendingboolean required

Whether the run promised when learning was turned on is still waiting to start.

turned_on_atstring date-time nullable required

When learning was last turned on; null until then.

updated_atstring date-time nullable required

When the settings last changed; null until learning is first turned on.

Changes

No recorded changes to this operation across all 1 revision of this API.