Skip to content
ViGrisePublic

About

Official ViGrise SDKs and command line

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

117 Commits

Folders and files

Repository files navigation

ViGrise SDK

Libraries and a command line for calling ViGrise services. Every language signs requests the same way (VGR4) and offers the same clients and operations for each ViGrise service.

Layout

Path Contents
rust/vigrise The vigrise crate
rust/vigrise-sso The vigrise-sso crate: first-party SSO for ViGrise apps on *.vigrise.com
rust/vigrise-cli The vigrise command line: login, logout, whoami
typescript/sdk The @vigrise/sdk package
typescript/sso The @vigrise/sso package: first-party SSO for ViGrise apps on *.vigrise.com
python The vigrise package
test-vectors Reference implementation and the VGR4 and webhook vectors every language passes
docs One guide per service

Languages

Language Install Requires Guide
Rust cargo add vigrise --features speech,storage Rust 1.85, edition 2024 rust/vigrise
TypeScript npm install @vigrise/sdk Node 24 typescript/sdk
Python pip install "vigrise[speech,storage]" Python 3.9 python
Command line cargo install vigrise-cli rust/vigrise-cli

Services

Service What it does Guide
Auth VGR4 signing, credentials, role sessions, sign-in from the command line docs/auth
Speech Text to speech, voice cloning, jobs and webhooks docs/speech
Storage Buckets, objects, multipart uploads, presigned URLs docs/storage
Accounts OAuth2 and OIDC sign-in, back-channel logout docs/accounts

Credentials

Clients read credentials from VIGRISE_ACCESS_KEY_ID and VIGRISE_SECRET_ACCESS_KEY (with VIGRISE_SESSION_TOKEN for a role session), then from profile VIGRISE_PROFILE (default default) of ~/.vigrise/credentials. vigrise login writes a role session to a profile. Details: docs/auth.

Endpoints

Each service lives on https://<service>-api.vigrise.com. A client resolves its endpoint from its endpoint argument, then VIGRISE_ENDPOINT_URL_<SERVICE> (for example VIGRISE_ENDPOINT_URL_SPEECH), then VIGRISE_ENDPOINT_URL for every service, then that default.

Contributing

See CONTRIBUTING.md.

License

Apache-2.0

About

Official ViGrise SDKs and command line

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages