IMimperfect
user-states

Get Activity Details

Changed on

Generate or return cached activity details (steps, technique_notes).

First request triggers a lightweight agent call (~2-3s). Subsequent requests return cached details instantly.

get/user_states/boards/{board_id}/activities/{activity_id}/details

Request

  • Base URL
    https://api.imperfect.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.imperfect.co/user_states/boards/{board_id}/activities/{activity_id}/details
  • Auth
    HTTP bearer

Path parameters

board_idstring required
activity_idstring required

Query parameters

user_idstring nullable

Headers

accept-languagestring nullable
x-device-timezonestring nullable
x-unitsstring nullable
x-units-sourcestring nullable

Response

Successful Response

idstring
type'hydration' | 'nutrition' | 'movement' | 'rest' | 'mental' | 'preparation' | 'facilities' required

Category of the activity

status'pending' | 'completed' | 'skipped'

Execution status

titlestring required

Short title. E.g. 'Hydration'.

descriptionstring required

Actionable description with specific amounts in the user's unit system. E.g. 'Drink 500ml water with electrolytes' (metric) / 'Drink 16oz water with electrolytes' (imperial).

headlinestring

Imperative + quantified, 3-5 words, in the user's unit system. E.g. 'Toma 500ml Agua', 'Run 5km Easy' (metric) / 'Drink 16oz Water', 'Run 3mi Easy' (imperial). Must include a specific number/amount.

short_descriptionstring

Brief context, 2-4 words. E.g. 'Pre-run Hydration'. Never repeat headline words.

sentiment'positive' | 'caution' | 'urgent' | 'neutral'

urgent: immediate health needs (dehydration, overtraining). caution: needs attention (poor sleep, high stress). positive: on track. neutral: informational.

requires_completionboolean

false ONLY for final sleep/rest items in the plan. These passive items must be LAST in the list.

estimated_duration_minutesinteger nullable

Total estimated duration in minutes

Changes