Credentials

Create credential

Creates a new credential for the current organization

post/v1/credentials

Headers

x-api-keystring nullable

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

Request body

namestring required

Name of the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

vault_type'skyvern' | 'bitwarden' | 'azure_vault' | 'gcp' | 'custom'

proxy_session_idstring nullable

Optional advanced reuse key for this credential's pinned proxy identity.

rotate_proxy_session_idboolean

Rotate the Skyvern-managed proxy sticky-session id when updating this credential.

browser_profile_idstring nullable

Optional plain browser profile to link as this credential's saved profile. Must be an unmanaged profile in your organization that no other credential already owns.

auto_profile_disabledboolean

Disable automatic saving and reuse of this credential's browser profile.

pin_saved_session_ipboolean

Keep the same IP across sign-ins that reuse this credential's saved profile.

tested_urlstring nullable

Example request

{
  "name": "Amazon Login",
  "credential": {
    "password": "securepassword123",
    "username": "user@example.com",
    "totp": "JBSWY3DPEHPK3PXP",
    "totp_identifier": "user@example.com"
  },
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Response

Successful Response

credential_idstring required

Unique identifier for the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

namestring required

Name of the credential

vault_type'skyvern' | 'bitwarden' | 'azure_vault' | 'gcp' | 'custom'

browser_profile_idstring nullable

Browser profile ID linked to this credential

auto_profile_disabledboolean nullable

Whether automatic saving and reuse of this credential's browser profile is disabled.

pin_saved_session_ipboolean

Whether sign-ins reusing this credential's saved profile keep the same IP

tested_urlstring nullable

user_contextstring nullable

User-provided context describing the login sequence (e.g., 'click SSO button first')

save_browser_session_intentboolean nullable

Whether the user intends to save a browser session, regardless of test outcome

run_sequentiallyboolean

folder_idstring nullable

ID of the credential folder this credential belongs to, if any

proxy_session_idstring nullable

Opaque Skyvern-managed proxy sticky-session id.

Example response

{
  "credential_id": "cred_1234567890",
  "credential": {
    "username": "user@example.com",
    "totp_identifier": "user@example.com"
  },
  "name": "Amazon Login",
  "folder_id": "cfld_1234567890",
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Changes

Changed in 13 of the 86 revisions of this API.5338

Aug 24, 2026cf49a4f3c1d43See the full diff
- ○
  the request property // became optional
  request-property-became-optional
- ○
  the request property default value was added
  request-property-default-value-added
- ○
  the // request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
Aug 8, 20265116249dfff32See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 30, 202630201945bb6512See the full diff
- ●
  added the new passkey enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new passkey enum value to the request property //
  request-property-enum-value-added
Jul 30, 2026b28e44e0ebec1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 24, 2026bd64e0480f0a3See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 23, 2026b86cb5c065d31See the full diff
- ○
  added the new optional request property
  new-optional-request-property
Jul 2, 202667aeacca9d0511See the full diff
- ●
  added the new skyvern enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new skyvern enum value to the request property /
  request-property-enum-value-added
Jun 29, 2026fc5ab0c10cbc1See the full diff
- ○
  added the new optional request property
  new-optional-request-property
Jun 26, 20269de266eb002a4See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 18, 2026915c28f217744See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property //
  new-optional-request-property

Full history (13 revisions)