api.md

Steel

Types:

• PdfResponse
• ScrapeResponse
• ScreenshotResponse

Methods:

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

Credentials

Types:

• 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:

• File
• Fileslist

Methods:

• client.files.list() -> Fileslist
• client.files.delete(path_) -> void
• client.files.download(path_) -> Response
• client.files.upload({ ...params }) -> File

Sessions

Types:

• Session
• SessionContext
• Sessionslist
• SessionComputerResponse
• SessionEventsResponse
• SessionLiveDetailsResponse
• SessionReleaseResponse
• SessionReleaseAllResponse

Methods:

• client.sessions.create({ ...params }) -> Session
• client.sessions.retrieve(id) -> Session
• client.sessions.list({ ...params }) -> SessionslistSessionsSessionsCursor
• client.sessions.computer(sessionId, { ...params }) -> SessionComputerResponse
• client.sessions.context(id) -> SessionContext
• client.sessions.events(id, { ...params }) -> SessionEventsResponse
• client.sessions.liveDetails(id) -> SessionLiveDetailsResponse
• client.sessions.release(id) -> SessionReleaseResponse
• client.sessions.releaseAll() -> SessionReleaseAllResponse

Files

Methods:

• client.sessions.files.list(sessionId) -> Fileslist
• client.sessions.files.delete(sessionId, path_) -> void
• client.sessions.files.deleteAll(sessionId) -> void
• client.sessions.files.download(sessionId, path_) -> Response
• client.sessions.files.downloadArchive(sessionId) -> Response
• client.sessions.files.upload(sessionId, { ...params }) -> File

Captchas

Types:

• CaptchaSolveResponse
• CaptchaSolveImageResponse
• CaptchaStatusResponse

Methods:

• client.sessions.captchas.solve(sessionId, { ...params }) -> CaptchaSolveResponse
• client.sessions.captchas.solveImage(sessionId, { ...params }) -> CaptchaSolveImageResponse
• client.sessions.captchas.status(sessionId) -> CaptchaStatusResponse

Extensions

Types:

• ExtensionUpdateResponse
• ExtensionListResponse
• ExtensionDeleteResponse
• ExtensionDeleteAllResponse
• ExtensionDownloadResponse
• ExtensionUploadResponse

Methods:

• client.extensions.update(extensionId, { ...params }) -> ExtensionUpdateResponse
• client.extensions.list() -> ExtensionListResponse
• client.extensions.delete(extensionId) -> ExtensionDeleteResponse
• client.extensions.deleteAll() -> ExtensionDeleteAllResponse
• client.extensions.download(extensionId) -> string
• client.extensions.upload({ ...params }) -> ExtensionUploadResponse

Profiles

Types:

• 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