mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2026-04-30 12:40:14 +00:00
docs: Major revamp to Developers and SDK Reference Tabs, Added Documentation for Page/Agent/Browser Methods (#5571)
This commit is contained in:
parent
6ff9350619
commit
e376b8a7e9
161 changed files with 9401 additions and 13566 deletions
79
docs/sdk-reference/credentials/send-totp-code.mdx
Normal file
79
docs/sdk-reference/credentials/send-totp-code.mdx
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: "send_totp_code"
|
||||
slug: sdk-reference/credentials/send-totp-code
|
||||
---
|
||||
|
||||
Send a TOTP (time-based one-time password) code to Skyvern during a run that requires 2FA. Call this when your webhook or polling detects that Skyvern is waiting for a TOTP code.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
await client.send_totp_code(
|
||||
totp_identifier="demo@example.com",
|
||||
content="123456",
|
||||
)
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
await skyvern.sendTotpCode({
|
||||
totp_identifier: "demo@example.com",
|
||||
content: "123456",
|
||||
});
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `totp_identifier` | `str` | Yes | The identifier matching the `totp_identifier` used in the task/workflow. |
|
||||
| `content` | `str` | Yes | The TOTP code value. |
|
||||
| `task_id` | `str` | No | Associate with a specific task run. |
|
||||
| `workflow_id` | `str` | No | Associate with a specific workflow. |
|
||||
| `workflow_run_id` | `str` | No | Associate with a specific workflow run. |
|
||||
| `source` | `str` | No | Source of the TOTP code. |
|
||||
| `expired_at` | `datetime` | No | When this code expires. |
|
||||
| `type` | `OtpType` | No | OTP type. |
|
||||
| `request_options` | `RequestOptions` | No | Per-request configuration (see below). |
|
||||
|
||||
### Returns `TotpCode`
|
||||
|
||||
---
|
||||
|
||||
### Request options
|
||||
|
||||
|
||||
Override timeout, retries, or headers for this call by passing `request_options` (Python) or a second options argument (TypeScript).
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
from skyvern.client.core import RequestOptions
|
||||
|
||||
request_options=RequestOptions(
|
||||
timeout_in_seconds=120,
|
||||
max_retries=3,
|
||||
additional_headers={"x-custom-header": "value"},
|
||||
)
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
// Pass as second argument to any method
|
||||
{
|
||||
timeoutInSeconds: 120,
|
||||
maxRetries: 3,
|
||||
headers: { "x-custom-header": "value" },
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
| Option (Python) | Option (TypeScript) | Type | Description |
|
||||
|-----------------|---------------------|------|-------------|
|
||||
| `timeout_in_seconds` | `timeoutInSeconds` | `int` / `number` | HTTP timeout in seconds. |
|
||||
| `max_retries` | `maxRetries` | `int` / `number` | Retry count. |
|
||||
| `additional_headers` | `headers` | `dict` / `Record<string, string>` | Extra headers. |
|
||||
| `additional_query_parameters` | - | `dict` | Extra query parameters. |
|
||||
| `additional_body_parameters` | - | `dict` | Extra body parameters. |
|
||||
| - | `abortSignal` | `AbortSignal` | Signal to cancel the request. |
|
||||
| - | `apiKey` | `string` | Override API key. |
|
||||
|
||||
|
||||
---
|
||||
Loading…
Add table
Add a link
Reference in a new issue