Edit the goal in place [write]

Changed on

A course correction for an active or paused goal, not a restart: the iteration count and spend already consumed carry over. Editing criteria marks them as the caller's. A completed or stopped goal returns 409; POST a new goal to start another outcome.

patch/sessions/{id}/goal

Request

  • Base URL
    https://api.agentsky.dev/v1
  • URL
    https://api.agentsky.dev/v1/sessions/{id}/goal
  • Auth
    HTTP bearer

Path parameters

idstring required

The session id

Headers

Idempotency-Keystring

Dedupes a retry of this mutation. The same key with a different body is refused with 409 idempotency_conflict.

Request body

objectivestring
max_iterationsinteger nullable
max_no_progressinteger nullable
max_tokensinteger nullable

Token ceiling for this goal: uncached input plus output, counted from the goal's start

max_duration_minutesinteger nullable

Response

OK

Changes

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the optional property / to the response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      removed subschema #1 from the / response property oneOf list for the response status