Quick Start¶

This page gets you from zero to a tracked session as fast as possible.

5-Minute Setup¶

If you only want to prove ScoutML works:

install the package
set SCOUTML_API_KEY
copy the example below
run it
open the sessions page

After the run, open:

https://scoutml.com/arg/research_sessions/

If you run ScoutML locally, open:

http://localhost:8000/arg/research_sessions/

1. Import¶

from scoutml import track

2. Start A Session¶

track.init(
    task="My first tracked run",
    agent_id="demo-agent",
    description="Learning ScoutML"
)

3. Add Decorators¶

@track.code
def write_code():
    return {"file": "main.py", "status": "updated"}

@track.search
def search_docs(query):
    return {"query": query, "results": 3}

@track.tool("browser")
def open_page(url):
    return {"url": url, "status": 200}

4. Run Your Functions¶

write_code()
search_docs("python decorators")
open_page("https://example.com")

5. Finish¶

track.note("Finished my first tracked run")
track.complete(summary={"result": "success"})

Full Example¶

from scoutml import track

track.init(
    task="My first tracked run",
    agent_id="demo-agent",
    description="Learning ScoutML"
)

@track.code
def write_code():
    return {"file": "main.py", "status": "updated"}

@track.search
def search_docs(query):
    return {"query": query, "results": 3}

@track.tool("browser")
def open_page(url):
    return {"url": url, "status": 200}

write_code()
search_docs("python decorators")
open_page("https://example.com")
track.note("Finished my first tracked run")
track.complete(summary={"result": "success"})

What You Will See¶

Your session will show:

one code action
one search action
one tool action
one note

To open one session directly, use:

https://scoutml.com/arg/research_sessions/<SESSION_ID>/

Next Step¶

Read the decorator guide to learn when to use each decorator.