SKskyvern-ai
Credentials

Send TOTP code

Changed on

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.

post/v1/credentials/totp

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/credentials/totp
  • Auth
    none declared

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

totp_identifierstring required

The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.

task_idstring nullable

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 nullable

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 nullable

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 nullable

An optional field. The source of the TOTP code. e.g. email, sms, etc.

contentstring required

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.

expired_atstring date-time nullable

The timestamp when the TOTP code expires

type'totp' | 'magic_link'

Example request

{
  "totp_identifier": "john.doe@example.com",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "content": "Hello, your verification code is 123456",
  "expired_at": "2025-01-01T00:00:00Z"
}

Response

Successful Response

totp_identifierstring required

The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.

task_idstring nullable

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 nullable

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 nullable

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 nullable

An optional field. The source of the TOTP code. e.g. email, sms, etc.

contentstring required

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.

expired_atstring date-time nullable

The timestamp when the TOTP code expires

type'totp' | 'magic_link'
totp_code_idstring required

The skyvern ID of the TOTP code.

codestring required

The TOTP code extracted from the content.

organization_idstring required

The ID of the organization that the TOTP code is for.

created_atstring date-time required

The timestamp when the TOTP code was created.

modified_atstring date-time required

The timestamp when the TOTP code was modified.

otp_type'totp' | 'magic_link'

Example response

{
  "totp_identifier": "john.doe@example.com",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "content": "Hello, your verification code is 123456",
  "expired_at": "2025-01-01T00:00:00Z"
}

Changes