POST
/
agent-profiles
JavaScript
import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const agentProfileView = await client.agentProfiles.create({ name: 'x' });

console.log(agentProfileView.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "highlightElements": true,
  "maxAgentSteps": 123,
  "allowedDomains": [
    "<string>"
  ],
  "flashMode": true,
  "thinking": true,
  "vision": true,
  "customSystemPromptExtension": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Browser-Use-API-Key
string
header
required

Body

application/json

Request model for creating a new agent profile

Attributes: name: Display name for the profile description: Optional description of the profile highlight_elements: Whether to highlight elements during agent interaction max_agent_steps: Maximum number of steps the agent can take allowed_domains: List of domains the agent is allowed to access flash_mode: Whether flash mode is enabled thinking: Whether thinking mode is enabled vision: Whether vision capabilities are enabled custom_system_prompt_extension: Optional custom system prompt for the agent

Response

201
application/json

Successful Response

View model for representing an agent profile

Attributes: id: Unique identifier for the profile name: Display name for the profile description: Optional description of the profile highlight_elements: Whether to highlight elements during agent interaction with the browser max_agent_steps: Maximum number of steps the agent can take before stopping allowed_domains: List of domains the agent is allowed to access flash_mode: Whether flash mode is enabled thinking: Whether thinking mode is enabled vision: Whether vision capabilities are enabled custom_system_prompt_extension: Optional custom system prompt for the agent created_at: Timestamp when the profile was created updated_at: Timestamp when the profile was last updated