Skip to main content
7 tools. Each one is also a REST route and a CLI command, from the same definition: the same input, the same output, the same errors.

get_context

Get the prioritised workspace context. The entry point to call first. Returns, in one call: the workspace counters, the tasks scored highest by the prioritisation engine (with the reasons behind each score), the active projects and the areas. The score combines the deadline, the scheduled date, the priority and whether the task belongs to a project. Calendar blocks are excluded.

Input

Output

Example

get_stats

Read the raw activity events. Completions and sessions since since, plus every day plan, all unaggregated. Bucketing by day or hour happens in the caller’s timezone, so the server returns moments rather than buckets: an hour histogram computed here would be wrong for everyone outside UTC. Plans are keyed by local day, which since cannot be compared against without that same timezone, so they are not windowed.

Input

Output

Example

list_activity

The feed. Finished sessions shared by the people you follow, and your own, newest first. A public one names the task; an anonymized one names only where it lived; a private one is not here.

Input

This tool takes no arguments.

Output

Example

list_realtime_events

List realtime events since a cursor. Returns this account’s events on the one realtime log, oldest first, after since. That id is the resume token: reconnect with it to fill a gap. An omitted since starts from the oldest retained event. A channel narrows to one stream (inbox, a place, a run, or activity). This read does not mark anything read.

Input

Output

Example

Search the workspace. Text search across task titles, project names and area names. Use this before asking the user for an identifier.

Input

Output

Example

whoami

Identify the account and the server date. Returns the token holder’s profile and the workspace counters. nextUsernameChangeAt is null when the username can be changed now, and a moment otherwise: a username is a public URL, so it moves at most once a fortnight. Important about dates: the server does not know your timezone and reasons in UTC. serverDay is the current UTC day. If your timezone differs, pass day explicitly to the operations that accept it.

Input

This tool takes no arguments.

Output

Example

send_flame

Send a flame. The one reaction. One per person per session; a second is a no-op. Only on a session you can see, and never on your own.

Input

Output

Example