Documentation Index
Fetch the complete documentation index at: https://docs.vers.sh/llms.txt
Use this file to discover all available pages before exploring further.
SDKs
Vers publishes official SDKs for 9 languages, all auto-generated from the OpenAPI spec and published to package registries on every API change.
Installation
TypeScript
Python
Go
Rust
Ruby
C#
Java
Kotlin
PHP
import { VersSdkClient } from "vers-sdk";
const client = new VersSdkClient({ apiKey: process.env.VERS_API_KEY });
const vms = await client.listVms();
from vers_sdk import VersSdkClient
client = VersSdkClient(api_key=os.environ["VERS_API_KEY"])
vms = client.list_vms()
go get github.com/hdresearch/go-sdk
import vers "github.com/hdresearch/go-sdk"
client := vers.NewVersSdkClient(os.Getenv("VERS_API_KEY"))
vms, err := client.ListVms(nil)
use vers_sdk::VersSdkClient;
let client = VersSdkClient::new(std::env::var("VERS_API_KEY")?);
let vms = client.list_vms(None).await?;
require "vers_sdk"
client = VersSdk::Client.new(api_key: ENV["VERS_API_KEY"])
vms = client.list_vms
dotnet add package vers-sdk
using VersSdk;
var client = new VersClient(Environment.GetEnvironmentVariable("VERS_API_KEY"));
var vms = await client.ListVmsAsync();
<!-- Maven — coming soon to Maven Central -->
<dependency>
<groupId>com.vers</groupId>
<artifactId>vers-sdk</artifactId>
<version>0.1.8</version>
</dependency>
import com.vers.sdk.VersClient;
VersClient client = new VersClient(System.getenv("VERS_API_KEY"));
List<VM> vms = client.listVms(null);
// Gradle
implementation("com.vers:vers-sdk:0.1.8")
import com.vers.sdk.VersClient
val client = VersClient(System.getenv("VERS_API_KEY"))
val vms = client.listVms()
composer require vers/sdk
use VersSdk\VersClient;
$client = new VersClient(getenv('VERS_API_KEY'));
$vms = $client->listVms();
Features
All SDKs include:
- Full API coverage — 63 operations across VMs, commits, repositories, domains, environment variables, and tags
- Typed models — Request/response types generated from the OpenAPI schema
- Error handling — Typed error responses with status codes
- Automatic retries — Configurable retry with exponential backoff and
Retry-After support
- Request options — Per-request timeout, headers, and idempotency key overrides
- Query parameters — Typed parameter interfaces for filtering and pagination
- Platform detection —
User-Agent header with SDK version, language runtime, and OS info
Authentication
All SDKs accept an API key via constructor or environment variable:
export VERS_API_KEY="your-api-key"
Source
SDKs are auto-generated by Sterling from the Chelsea OpenAPI spec and published on every API change.