TEteaflask
authed

Change learning settings

Changed on

Change learning's settings; only the settings present change. Turning learning on needs a cadence and a time zone, and starts a first run at once unless the first scheduled run is under 6 hours away. Turning it off stops a run in progress and keeps what it found so far. The change is saved even when the scheduler can't be reached; schedule_in_sync then stays false until it catches up.

patch/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

Request body

enabledboolean

Turn learning on or off. Turning it on needs a cadence and a time zone; turning it off stops a run in progress.

cadence'daily' | 'weekly' | 'monthly'
timezonestring

The IANA time zone runs are timed in, like Europe/Berlin.

monthly_spend_cap_microusdinteger nullable

The most learning may spend in a calendar month (UTC), from $1.00 to $100,000.00; null removes the cap. In microusd: millionths of a US dollar (1,000,000 = $1.00).

Response

Successful Response

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

The earliest the next scheduled run starts; it starts within the hour after this time. 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

  • c6ac9fd6657fRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status