Skip to main content
POST
/
v1
/
credentials
Create credential
curl --request POST \
  --url https://api.skyvern.com/v1/credentials \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Credential",
  "credential_type": "PASSWORD",
  "credential": {
    "username": "user@example.com",
    "password": "securepassword123",
    "totp": "JBSWY3DPEHPK3PXP"
  }
}
'
{
  "credential_id": "cred_1234567890",
  "credential": {
    "username": "user@example.com",
    "totp_type": "authenticator",
    "totp_identifier": "user@example.com"
  },
  "credential_type": "password",
  "name": "Amazon Login"
}

Headers

x-api-key
string | null

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

Body

application/json

The credential data to create

name
string
required

Name of the credential

Example:

"Amazon Login"

credential_type
enum<string>
required

Type of credential to create

Available options:
password,
credit_card,
secret
credential
NonEmptyPasswordCredential · object
required

Password credential model that requires non-empty values.

Example:
{
"password": "securepassword123",
"username": "user@example.com"
}

Response

Successful Response

Response model for credential operations.

credential_id
string
required

Unique identifier for the credential

Example:

"cred_1234567890"

credential
PasswordCredentialResponse · object
required

Response model for password credentials, containing only the username.

credential_type
enum<string>
required

Type of the credential

Available options:
password,
credit_card,
secret
name
string
required

Name of the credential

Example:

"Amazon Login"