Quickstart

The CLI is the fastest way to exercise the same API your application will use. It requires Node.js 20 or newer.

1. Install and authenticate

npm install --global @fluenterp/cli
fluent auth login
fluent auth status

fluent auth login opens a browser and uses OAuth with PKCE. For CI or another unattended environment, set a dedicated API key instead:

export FLUENT_API_KEY="fl-..."

See Authentication for credential and scope details.

fluent agents list

The output includes each accessible agent’s ID, name, and description. Agent names are accepted by runs create when the name is unique.

Run an agent with a document:

fluent runs create \
  --agent "Accounts Payable" \
  --file invoice.pdf \
  --wait

Or run an agent with a text instruction:

fluent runs create \
  --agent "Operations" \
  --message "Summarize our open issues" \
  --wait

Without --wait, the command returns immediately with a run ID and status URL. Use that ID to inspect or follow the run:

fluent runs get "$RUN_ID"
fluent runs watch "$RUN_ID"

Every resource command supports --json, which is the stable interface for scripts:

fluent runs create \
  --agent "$AGENT_ID" \
  --file invoice.pdf \
  --wait \
  --json

A watched run exits nonzero when its final status is failed or cancelled, so CI jobs fail naturally.