Skip to main content
from simplex import SimplexClient client = SimplexClient(api_key="your_api_key") result = client.store_credential("github_token", "ghp_xxxxxxxxxxxx") print(result)
{
  "succeeded": true,
  "name": "<string>",
  "credential_id": "<string>",
  "error": "<string>"
}
Encrypt and store a credential for your organization. The plaintext value is encrypted server-side with Evervault before being persisted — the raw value is never stored. Once stored, the agent can use type_secret(credential_name="...") during a browser session to decrypt and type the credential into form fields without exposing it in logs or screenshots.
Credentials are scoped to your organization. If you store a credential with the same name twice, the previous value is overwritten.

​
Use cases

  • Login passwords — store passwords and let the agent type them securely
  • API tokens — store tokens for sites the agent visits (e.g. GitHub PATs)
  • MFA recovery codes — store backup codes for automated flows

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
name
string
required

A unique name for the credential (e.g. 'github_token', 'aws_secret_key')

​
value
string
required

The plaintext value to encrypt and store

Response

200 - application/json

Credential stored successfully

​
succeeded
boolean
required
​
name
string

The credential name

​
credential_id
string

The unique ID of the stored credential

​
error
string