find_path
Find the Ableton Live API path that fulfills your intent, returning matching catalog rows with paths, verbs, and documentation. Use this to discover how to achieve a desired action in Live.
Instructions
Find the mechanism that serves an intent, and the catalog rows when rows serve it.
Returns:
Dictionary with the chosen route, any matching rows with their paths and docs,
and the next call to make when rows are not the answer.
Note:
Four routes, and which one comes back matters more than the rows do.
``catalog_row`` means the rows carry the answer. Each hit gives the path
template to fill in, the access verbs, the full doc, and ``scopes``: the other
places the same property exists, since track, return, master and chain mirror one
another and a clip row usually has an arrangement_clip twin. ``writes`` appears
when the best row is a read-only parameter object and names the sibling that
actually takes a value.
``device_parameter`` means the answer is a knob inside a device, which this
catalog cannot enumerate: what a device exposes depends on the device. Filter
cutoff, resonance, attack, threshold and every other parameter behind a device
front panel arrive this way, with the procedure to reach them.
``blocked`` means Live's API cannot do it at all, with what to do in Live
instead. ``intent_tool`` is reported in the ``tool`` field alongside the rows
rather than in place of them, because a tool that verifies its own work is the
better route to the same end but the path is still worth seeing.
``unresolved`` means nothing matched. ``unmatched`` lists the words that found
nothing, which is usually where the query went wrong.
This exists so that finding a path costs about 1.5k tokens instead of reading the
whole catalog. It does not touch Live: it reads the catalog only, so nothing here
proves anything about the set that is open.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | No | Restrict to one catalog area, e.g. 'clip' or 'track'. The areas are listed in the live://catalog resource. Empty searches all of them. | |
| limit | No | How many rows to return. Six is about 1.5k tokens. | |
| query | Yes | What you want to do, in your own words. 'turn the bass down', 'sidechain the pad', 'where is the loop brace'. Producer vocabulary is expected: the lookup translates it into the catalog's own words. | |
| access | No | Restrict to rows granting this verb: get, set, call, observe or automate. Use 'set' when you intend to write, which filters out the read-only parameter objects. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||