Skip to main content
VRINClient is the single entry point for queries, knowledge management, file uploads, conversations, auth, and health checks.

Constructor

Parameters

string
required
Your Vrin API key. Keys starting with vrin_ route to Vrin shared infrastructure. Keys starting with vrin_ent_ route to your enterprise AWS account (use VRINEnterpriseClient for those).
float
default:"120.0"
Default timeout in seconds for all HTTP requests. Individual methods may override this.
int
default:"2"
Number of retries on server errors (5xx) and connection failures. Client errors (401, 429) are never retried. Uses exponential backoff (2^attempt seconds).

Context manager

VRINClient implements the context manager protocol. The underlying HTTP session is closed on exit.

Properties

Optional[str]
The active conversation session ID, or None if no conversation is in progress.
List[str]
List of ended conversation session IDs from this client instance.

Auto-detection

If you are not sure whether a key is standard or enterprise, use the factory helper:

Methods overview

Health check

Returns service health information. Useful for connectivity validation and monitoring.

Retry behavior

The client automatically retries on:
  • HTTP 5xx responses
  • requests.ConnectionError
  • requests.Timeout
It does not retry on:
  • HTTP 401 (AuthenticationError)
  • HTTP 429 (RateLimitError)
  • ValidationError
Backoff is exponential: 1s, 2s, 4s for retries 1, 2, 3.