api.md

Steel

Types:

from steel.types import PdfResponse, ScrapeResponse, ScreenshotResponse

Methods:

• client.pdf(**params) -> PdfResponse
• client.scrape(**params) -> ScrapeResponse
• client.screenshot(**params) -> ScreenshotResponse

Credentials

Types:

from steel.types import (
    CredentialCreateResponse,
    CredentialUpdateResponse,
    CredentialListResponse,
    CredentialDeleteResponse,
)

Methods:

• client.credentials.create(**params) -> CredentialCreateResponse
• client.credentials.update(**params) -> CredentialUpdateResponse
• client.credentials.list(**params) -> CredentialListResponse
• client.credentials.delete(**params) -> CredentialDeleteResponse

Files

Types:

from steel.types import File, Fileslist

Methods:

• client.files.list() -> Fileslist
• client.files.delete(path) -> None
• client.files.download(path) -> BinaryAPIResponse
• client.files.upload(**params) -> File

Sessions

Types:

from steel.types import (
    Session,
    SessionContext,
    Sessionslist,
    SessionComputerResponse,
    SessionEventsResponse,
    SessionLiveDetailsResponse,
    SessionReleaseResponse,
    SessionReleaseAllResponse,
)

Methods:

• client.sessions.create(**params) -> Session
• client.sessions.retrieve(id) -> Session
• client.sessions.list(**params) -> SyncSessionsCursor[Session]
• client.sessions.computer(session_id, **params) -> SessionComputerResponse
• client.sessions.context(id) -> SessionContext
• client.sessions.events(id, **params) -> SessionEventsResponse
• client.sessions.live_details(id) -> SessionLiveDetailsResponse
• client.sessions.release(id) -> SessionReleaseResponse
• client.sessions.release_all() -> SessionReleaseAllResponse

Files

Methods:

• client.sessions.files.list(session_id) -> Fileslist
• client.sessions.files.delete(path, *, session_id) -> None
• client.sessions.files.delete_all(session_id) -> None
• client.sessions.files.download(path, *, session_id) -> BinaryAPIResponse
• client.sessions.files.download_archive(session_id) -> BinaryAPIResponse
• client.sessions.files.upload(session_id, **params) -> File

Captchas

Types:

from steel.types.sessions import (
    CaptchaSolveResponse,
    CaptchaSolveImageResponse,
    CaptchaStatusResponse,
)

Methods:

• client.sessions.captchas.solve(session_id, **params) -> CaptchaSolveResponse
• client.sessions.captchas.solve_image(session_id, **params) -> CaptchaSolveImageResponse
• client.sessions.captchas.status(session_id) -> CaptchaStatusResponse

Extensions

Types:

from steel.types import (
    ExtensionUpdateResponse,
    ExtensionListResponse,
    ExtensionDeleteResponse,
    ExtensionDeleteAllResponse,
    ExtensionDownloadResponse,
    ExtensionUploadResponse,
)

Methods:

• client.extensions.update(extension_id, **params) -> ExtensionUpdateResponse
• client.extensions.list() -> ExtensionListResponse
• client.extensions.delete(extension_id) -> ExtensionDeleteResponse
• client.extensions.delete_all() -> ExtensionDeleteAllResponse
• client.extensions.download(extension_id) -> str
• client.extensions.upload(**params) -> ExtensionUploadResponse

Profiles

Types:

from steel.types import (
    ProfileCreateResponse,
    ProfileUpdateResponse,
    ProfileListResponse,
    ProfileGetResponse,
)

Methods:

• client.profiles.create(**params) -> ProfileCreateResponse
• client.profiles.update(id, **params) -> ProfileUpdateResponse
• client.profiles.list() -> ProfileListResponse
• client.profiles.get(id) -> ProfileGetResponse