API ReferenceCredentials

Send TOTP code

Forward a TOTP (2FA, MFA) email or sms message containing the code to Skyvern. This endpoint stores the code in database so that Skyvern can use it while running tasks/workflows.

Headers

x-api-keystring or nullOptional
Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request

This endpoint expects an object.
totp_identifierstringRequired
The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.
contentstringRequired
The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.
task_idstring or nullOptional

The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.

workflow_idstring or nullOptional
The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.
workflow_run_idstring or nullOptional
The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.
sourcestring or nullOptional
An optional field. The source of the TOTP code. e.g. email, sms, etc.
expired_atstring or nullOptionalformat: "date-time"
The timestamp when the TOTP code expires

Response

Successful Response
totp_identifierstring
The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.
contentstring
The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.
totp_code_idstring
The skyvern ID of the TOTP code.
codestring
The TOTP code extracted from the content.
organization_idstring
The ID of the organization that the TOTP code is for.
created_atstringformat: "date-time"
The timestamp when the TOTP code was created.
modified_atstringformat: "date-time"
The timestamp when the TOTP code was modified.
task_idstring or null

The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.

workflow_idstring or null
The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.
workflow_run_idstring or null
The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.
sourcestring or null
An optional field. The source of the TOTP code. e.g. email, sms, etc.
expired_atstring or nullformat: "date-time"
The timestamp when the TOTP code expires
otp_typeenum or null
The type of the OTP code.
Allowed values:

Errors