SKskyvern-ai
Credentials

Create credential

Changed on

Creates a new credential for the current organization

post/v1/credentials

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/credentials
  • Auth
    API key in header x-api-key

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' | 'onepassword' | 'bitwarden_connected'
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

Login page URL used during the credential test

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' | 'onepassword' | 'bitwarden_connected'
vault_idstring nullable

1Password vault ID for linked credentials

item_idstring nullable

1Password item ID for linked credentials

upstream_missing_atstring date-time nullable

When the linked 1Password item was last found missing upstream

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

Login page URL used during the credential test

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.

created_bystring nullable

ID of the user who created the credential

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

  • af198ec3f005Revision changes
    • warning

      added the new bitwarden_connected enum value to the / response property for the response status

    • info

      added the new bitwarden_connected enum value to the request property /

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API