api.md

Certificates

Types:

from browserbase.types import Certificate, CertificateListResponse

Methods:

• client.certificates.create(**params) -> Certificate
• client.certificates.retrieve(id) -> Certificate
• client.certificates.list() -> CertificateListResponse
• client.certificates.delete(id) -> None

Contexts

Types:

from browserbase.types import Context, ContextCreateResponse, ContextUpdateResponse

Methods:

• client.contexts.create(**params) -> ContextCreateResponse
• client.contexts.retrieve(id) -> Context
• client.contexts.update(id) -> ContextUpdateResponse
• client.contexts.delete(id) -> None

Extensions

Types:

from browserbase.types import Extension

Methods:

• client.extensions.create(**params) -> Extension
• client.extensions.retrieve(id) -> Extension
• client.extensions.delete(id) -> None

FetchAPI

Types:

from browserbase.types import FetchAPICreateResponse

Methods:

• client.fetch_api.create(**params) -> FetchAPICreateResponse

Projects

Types:

from browserbase.types import Project, ProjectUsage, ProjectListResponse

Methods:

• client.projects.retrieve(id) -> Project
• client.projects.list() -> ProjectListResponse
• client.projects.usage(id) -> ProjectUsage

Search

Types:

from browserbase.types import SearchWebResponse

Methods:

• client.search.web(**params) -> SearchWebResponse

Sessions

Types:

from browserbase.types import (
    Session,
    SessionLiveURLs,
    SessionCreateResponse,
    SessionRetrieveResponse,
    SessionListResponse,
)

Methods:

• client.sessions.create(**params) -> SessionCreateResponse
• client.sessions.retrieve(id) -> SessionRetrieveResponse
• client.sessions.update(id, **params) -> Session
• client.sessions.list(**params) -> SessionListResponse
• client.sessions.debug(id) -> SessionLiveURLs

Downloads

Methods:

• client.sessions.downloads.list(id) -> BinaryAPIResponse

Logs

Types:

from browserbase.types.sessions import SessionLog, LogListResponse

Methods:

• client.sessions.logs.list(id) -> LogListResponse

Recording

Types:

from browserbase.types.sessions import SessionRecording, RecordingRetrieveResponse

Methods:

• client.sessions.recording.retrieve(id) -> RecordingRetrieveResponse

Uploads

Types:

from browserbase.types.sessions import UploadCreateResponse

Methods:

• client.sessions.uploads.create(id, **params) -> UploadCreateResponse

Replays

Types:

from browserbase.types.sessions import ReplayRetrieveResponse

Methods:

• client.sessions.replays.retrieve(id) -> ReplayRetrieveResponse
• client.sessions.replays.retrieve_page(page_id, *, id) -> BinaryAPIResponse

Agents

Types:

from browserbase.types import (
    AgentCreateResponse,
    AgentRetrieveResponse,
    AgentUpdateResponse,
    AgentListResponse,
)

Methods:

• client.agents.create(**params) -> AgentCreateResponse
• client.agents.retrieve(agent_id) -> AgentRetrieveResponse
• client.agents.update(agent_id, **params) -> AgentUpdateResponse
• client.agents.list(**params) -> AgentListResponse
• client.agents.delete(agent_id) -> None

Runs

Types:

from browserbase.types.agents import (
    RunCreateResponse,
    RunRetrieveResponse,
    RunListResponse,
    RunListMessagesResponse,
)

Methods:

• client.agents.runs.create(**params) -> RunCreateResponse
• client.agents.runs.retrieve(run_id) -> RunRetrieveResponse
• client.agents.runs.list(**params) -> RunListResponse
• client.agents.runs.list_messages(run_id, **params) -> RunListMessagesResponse