Register
Create a new Vrin account. This is a static method — no client instance needed.
from vrin import VRINClient
result = VRINClient.register("user@example.com", "your-password", name="Jane Smith")
Parameters
Email address for the new account.
Password for the new account.
Login
Authenticate and receive an API key. Also a static method.
result = VRINClient.login("user@example.com", "your-password")
api_key = result["api_key"]
# Now create a client
client = VRINClient(api_key=api_key)
Parameters
Returns
{
"api_key": "vrin_abc123...",
"user_id": "user_xyz",
"email": "user@example.com"
}
API key management
These methods require an authenticated client instance.
List API keys
keys = client.list_api_keys()
Create an API key
new_key = client.create_api_key(name="Production Integration")
print(new_key["api_key"]) # Save this -- it won't be shown again
Optional human-readable name for the key.
Delete an API key
client.delete_api_key("key_id_to_delete")
The ID of the key to delete (not the key itself).
Check plan and limits
limits = client.get_limits()
print(f"Plan: {limits['plan']}")
print(f"Queries remaining: {limits['queries_remaining']}")
print(f"Inserts remaining: {limits['inserts_remaining']}")
{
"plan": "free",
"queries_remaining": 100,
"inserts_remaining": 50,
"allowed_models": ["gpt-4o-mini"],
"max_file_size_mb": 10
}
API key prefixes
| Prefix | Routing |
|---|
vrin_ | Vrin shared infrastructure |
vrin_ent_ | Customer’s own AWS account (enterprise) |
