SDKs & Libraries

Official SDKs and libraries for integrating Archivus into your applications.

Available SDKs

SDK Language Install
Go SDK Go go get github.com/ubiship/archivus-go
Python SDK Python pip install archivus-python
JavaScript SDK TypeScript/JS npm install @archivus/client
cURL Examples Shell No install needed

Archivus is built with Go, making the Go SDK the most natural choice for Go applications.

Quick Start

Go 

go get github.com/ubiship/archivus-go

package main

import (
    "context"
    "github.com/ubiship/archivus-go"
)

func main() {
    client := archivus.NewClient(
        archivus.WithAPIKey("ak_live_YOUR_API_KEY"),
    )

    docs, _ := client.Documents.List(context.Background(), nil)
}

Python 

pip install archivus-python

from archivus import ArchivusClient

client = ArchivusClient(api_key="ak_live_YOUR_API_KEY")
documents = client.documents.list()

JavaScript 

npm install @archivus/client

import { ArchivusClient } from '@archivus/client';

const client = new ArchivusClient({
  apiKey: 'ak_live_YOUR_API_KEY'
});

const documents = await client.documents.list();

Features

All SDKs provide:

Feature Description
Full API Coverage All endpoints available
Type Safety Go structs, Python type hints, TypeScript types
Error Handling Structured error types with codes
Rate Limiting Automatic rate limit handling with backoff
Retry Logic Automatic retries for transient errors
Authentication API keys and JWT token support

Authentication

All SDKs support two authentication methods:

ak_live_YOUR_API_KEY

API keys are scoped to specific permissions and are ideal for server-to-server communication.

JWT Tokens (For browser/mobile apps)

JWT tokens are issued after user login and should be used for end-user applications.

See the Authentication Guide for details on obtaining credentials.

Choosing an SDK

Use Case Recommended SDK
Backend services in Go Go SDK
Python scripts & automation Python SDK
Web applications JavaScript SDK
Mobile apps (React Native) JavaScript SDK
Quick testing cURL

Getting Started

  1. Get API Key - Create an API key in your dashboard
  2. Install SDK - Use the install command for your language
  3. Initialize Client - Configure with your API key
  4. Make Requests - Start calling the API

Resources

Questions? Contact support@ubiship.com

Table of contents