api.md

Certificates

Types:

• Certificate
• CertificateListResponse

Methods:

• client.certificates.create({ ...params }) -> Certificate
• client.certificates.retrieve(id) -> Certificate
• client.certificates.list() -> CertificateListResponse
• client.certificates.delete(id) -> void

Contexts

Types:

• Context
• ContextCreateResponse
• ContextUpdateResponse

Methods:

• client.contexts.create({ ...params }) -> ContextCreateResponse
• client.contexts.retrieve(id) -> Context
• client.contexts.update(id) -> ContextUpdateResponse
• client.contexts.delete(id) -> void

Extensions

Types:

• Extension

Methods:

• client.extensions.create({ ...params }) -> Extension
• client.extensions.retrieve(id) -> Extension
• client.extensions.delete(id) -> void

FetchAPI

Types:

• FetchAPICreateResponse

Methods:

• client.fetchAPI.create({ ...params }) -> FetchAPICreateResponse

Functions

Secrets

Types:

• SecretListResponse

Methods:

• client.functions.secrets.list(id, { ...params }) -> SecretListResponse
• client.functions.secrets.attach(id, { ...params }) -> void
• client.functions.secrets.detach(id, secretId) -> void

Projects

Types:

• Project
• ProjectUsage
• ProjectListResponse

Methods:

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

Search

Types:

• SearchWebResponse

Methods:

• client.search.web({ ...params }) -> SearchWebResponse

Secrets

Types:

• Secret
• SecretsKeypair
• SecretListResponse

Methods:

• client.secrets.create({ ...params }) -> Secret
• client.secrets.retrieve(id) -> Secret
• client.secrets.update(id, { ...params }) -> Secret
• client.secrets.list({ ...params }) -> SecretListResponse
• client.secrets.delete(id) -> void
• client.secrets.getPublicKey() -> SecretsKeypair

Sessions

Types:

• 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, { ...params }) -> SessionLiveURLs

Downloads

Methods:

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

Logs

Types:

• SessionLog
• LogListResponse

Methods:

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

Recording

Types:

• SessionRecording
• RecordingRetrieveResponse

Methods:

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

Downloads

Types:

• RecordingDownload
• DownloadCreateResponse
• DownloadListResponse

Methods:

• client.sessions.recording.downloads.create(id) -> DownloadCreateResponse
• client.sessions.recording.downloads.list(id) -> DownloadListResponse

Uploads

Types:

• UploadCreateResponse

Methods:

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

Replays

Types:

• ReplayRetrieveResponse

Methods:

• client.sessions.replays.retrieve(id) -> ReplayRetrieveResponse
• client.sessions.replays.retrievePage(id, pageId) -> Response

Agents

Types:

• AgentCreateResponse
• AgentRetrieveResponse
• AgentUpdateResponse
• AgentListResponse

Methods:

• client.agents.create({ ...params }) -> AgentCreateResponse
• client.agents.retrieve(agentId) -> AgentRetrieveResponse
• client.agents.update(agentId, { ...params }) -> AgentUpdateResponse
• client.agents.list({ ...params }) -> AgentListResponse
• client.agents.delete(agentId) -> void

Runs

Types:

• RunCreateResponse
• RunRetrieveResponse
• RunListResponse
• RunListMessagesResponse

Methods:

• client.agents.runs.create({ ...params }) -> RunCreateResponse
• client.agents.runs.retrieve(runId) -> RunRetrieveResponse
• client.agents.runs.list({ ...params }) -> RunListResponse
• client.agents.runs.listMessages(runId, { ...params }) -> RunListMessagesResponse

Webhooks

Types:

• Webhook
• WebhookCreateResponse
• WebhookListResponse
• WebhookRotateSecretResponse

Methods:

• client.webhooks.create({ ...params }) -> WebhookCreateResponse
• client.webhooks.retrieve(id) -> Webhook
• client.webhooks.update(id, { ...params }) -> Webhook
• client.webhooks.list({ ...params }) -> WebhookListResponse
• client.webhooks.delete(id) -> void
• client.webhooks.rotateSecret(id, { ...params }) -> WebhookRotateSecretResponse