Skip to main content

SDK Overview

The Alien Intelligence platform provides auto-generated client libraries for Python and TypeScript that give you type-safe access to the Data API running on each data cluster. Both SDKs are generated from the Data API's OpenAPI specification, so they always match the current API surface.

Available SDKs​

SDKPackage NameLanguageRegistry
Pythondata-api-clientPython 3.11+GitLab PyPI
TypeScript@alien/data-api-clientTypeScript / JavaScriptGitLab npm

Both packages are published to the Alien Intelligence GitLab Package Registry and updated automatically when the Data API changes.

What the SDKs Cover​

The SDKs wrap the Data API — the API running on each data cluster that handles datasets, entries, file storage, and search. Operations include:

  • Datasets — List, create, get, update, delete datasets.
  • Entries — Create entries, upload files, batch retrieve entries and content.
  • Search — Keyword search (Meilisearch) and semantic vector search (Qdrant).
  • Files — Download original and processed files, including extracted figures.
  • Health — Check data cluster API availability.

All models are fully typed — you get IDE autocompletion, type checking, and Pydantic validation (Python) or TypeScript interfaces out of the box.

SDK vs Direct API Calls​

Use the SDK when...Use direct API calls when...
You want type safety and IDE autocompletionYou need fine-grained control over HTTP requests
You are building in Python or TypeScriptYou are working in a language without an SDK
You want auto-generated models for request/response bodiesYou need to integrate with a custom HTTP client
You prefer high-level method calls over raw HTTPYou are making a one-off request (e.g., from cURL)

How Requests Are Routed​

For Alien Hosted deployments (the default), SDK requests go through the platform backend proxy:

Your Code (SDK)
    │
    v
https://api.alien.club/clusters/{cluster_id}/proxy/*
    │
    v
Platform Backend (authenticates, authorizes, logs)
    │
    v
Data Cluster API (your data)

The backend proxy handles authentication validation and audit logging. Your data cluster is never directly exposed to the internet.

For on-premise deployments with direct cluster access, you can point the SDK directly at the cluster's Data API URL using a service API key. See Data API Overview for details.

Quick Install​

Python​

pip install data-api-client \
  --extra-index-url https://gitlab.com/api/v4/projects/75857874/packages/pypi/simple

TypeScript​

# Configure the registry (one-time)
npm config set @alien:registry https://gitlab.com/api/v4/projects/75857874/packages/npm/

# Install
npm install @alien/data-api-client

Next Steps​