v2
latestOpenAPI 3.1.02026-07-3176157210.9 KBagents
Agent Start
post/agents/start
Headers
x-notte-request-originstring nullable
x-notte-sdk-versionstring nullable
Request body
taskstring required
The task that the agent should perform
urlstring nullable
The URL that the agent should start on (optional)
{"stackTrail":"components:schemas:ApiAgentStartRequest:properties:response_format:anyOf","oasType":"schema","type":"unknown","title":"Response Format","description":"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.)","nullable":true}
session_offsetinteger nullable
[Experimental] The step from which the agent should gather information from in the session. If none, fresh memory
use_visionboolean
Whether to use vision for the agent. Not all reasoning models support vision.
max_stepsinteger
The maximum number of steps the agent should take
vault_idstring nullable
The vault to use for the agent
persona_idstring nullable
The persona to use for the agent
notifier_configobject nullable
Config used for the notifier
session_idstring required
The ID of the session to run the agent on
Response
Successful Response
agent_idstring required
The ID of the agent
created_atstring date-time required
The creation time of the agent
session_idstring required
The ID of the session
status'active' | 'closed' required
closed_atstring date-time nullable
The closing time of the agent
savedboolean
Whether the agent is saved as a workflow