Configuration¶

ScoutML needs an API key so it can send session data to the ScoutML app.

Option 1: Environment Variable¶

This is the easiest option.

export SCOUTML_API_KEY="your-api-key"

$env:SCOUTML_API_KEY="your-api-key"

scoutml configure --api-key your-api-key

Most users do not need these.

export SCOUTML_API_URL="https://scoutml.com"
export SCOUTML_API_PREFIX="arg/research_sessions/api/v1"

Use a custom URL only if your team told you to use a local or private ScoutML server.

Run this in Python:

from scoutml import track

track.init(task="Config check", agent_id="demo-agent")
track.note("Configuration works")
track.complete()

If that runs without an authentication error, your key is set correctly.

Make sure the variable name is exactly:

SCOUTML_API_KEY