Skip to main content
POST
/
agents
/
start
python
from notte_sdk import NotteClient

notte = NotteClient()
task = "find a cute dog on google images"

with notte.Session() as session:
    agent = notte.Agent(session=session, max_steps=5)
    # this runs the agent and waits for completion
    full_response = agent.run(task=task)
    print(f"{full_response.success=}, {full_response.answer=}")
{
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "<string>",
  "status": "active",
  "closed_at": "2023-11-07T05:31:56Z",
  "saved": false
}

Documentation Index

Fetch the complete documentation index at: https://notte-experiment-visibility-md-links.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-notte-request-origin
string | null
​
x-notte-sdk-version
string | null

Body

application/json
​
task
string
required

The task that the agent should perform

​
session_id
string
required

The ID of the session to run the agent on

​
url
string | null

The URL that the agent should start on (optional)

​
response_format
any | null

The response format to use for the agent answer. You can use a Pydantic model or a JSON Schema dict (cf. https://docs.pydantic.dev/latest/concepts/json_schema/#generating-json-schema.)

​
session_offset
integer | null

[Experimental] The step from which the agent should gather information from in the session. If none, fresh memory

​
reasoning_model

The reasoning model to use

Available options:
openai/gpt-4o,
gemini/gemini-2.5-flash,
vertex_ai/gemini-2.5-flash,
openrouter/google/gemma-3-27b-it,
cerebras/gpt-oss-120b,
groq/gpt-oss-120b,
perplexity/sonar-pro,
deepseek/deepseek-r1,
together_ai/meta-llama/llama-3.3-70b-instruct,
anthropic/claude-sonnet-4-5-20250929,
moonshot/kimi-k2.5,
xai/grok-4-1-fast-non-reasoning,
minimax/minimax-m2.5
​
use_vision
boolean
default:true

Whether to use vision for the agent. Not all reasoning models support vision.

​
max_steps
integer
default:20

The maximum number of steps the agent should take

Required range: 1 <= x <= 150
​
vault_id
string | null

The vault to use for the agent

​
persona_id
string | null

The persona to use for the agent

​
notifier_config
Notifier Config · object

Config used for the notifier

Response

Successful Response

​
agent_id
string
required

The ID of the agent

​
created_at
string<date-time>
required

The creation time of the agent

​
session_id
string
required

The ID of the session

​
status
enum<string>
required

The status of the agent (active or closed)

Available options:
active,
closed
​
closed_at
string<date-time> | null

The closing time of the agent

​
saved
boolean
default:false

Whether the agent is saved as a workflow