Developer CLI

What an agent can be for

GET/v1/cli/purposes

The purposes of the console’s “Add an agent”, each with the rule it would get in this workspace, in words.

#Authentication

CLI token

A token (imc_...) the developer CLI gets by signing in through the browser (immiscible login, the OAuth device grant), sent as Authorization: Bearer. It acts for one person in one workspace: it reads agents and status, and registers an agent with a rule from the same purposes as the console's "Add an agent". It never approves anything or changes an existing rule. Every use re-checks the person's membership and the workspace's sign-in rules; it lasts 90 days and ends from the console's sessions.

Request

curl "https://immiscible.fly.dev/v1/cli/purposes" \
  -H "authorization: Bearer $IMMISCIBLE_TOKEN"

const res = await fetch('https://immiscible.fly.dev/v1/cli/purposes', {
  headers: {
    authorization: `Bearer ${process.env.IMMISCIBLE_TOKEN}`,
  },
});
const data = await res.json();
console.log(res.status, data);

import os
import requests

res = requests.get(
    "https://immiscible.fly.dev/v1/cli/purposes",
    headers={
        "authorization": f"Bearer {os.environ['IMMISCIBLE_TOKEN']}",
    },
)
print(res.status_code, res.json())

Response

JSON

{
  "data": [
    {
      "id": "pays_invoices",
      "label": "Pays invoices",
      "kind": "payment",
      "rule": "Pays up to £10,000 at a time and £50,000 a month. Payments above £5,000 need a person. A supplier it has not paid before needs a person."
    }
  ]
}