---
id: metal-sdk
version: "2.5.1"
license: unclear
license_treatment: permissive
maintenance: dormant
---

# metal-sdk — SDK for getmetal.io

License: permissive · Maintenance: dormant · Downloads: 129.8K/mo

## What it is and what it does

metal-sdk is a Python client for the Metal document indexing and retrieval service. It wraps the Metal API to let you index documents and query them, handling HTTP communication and credential management through a simple object interface. The library depends only on httpx for HTTP requests and typing-extensions for type hints, making it lightweight to install.

The package is dormant—its last release was 2023-11-10—so it receives no active maintenance. If the underlying Metal service has evolved or introduced breaking changes, this SDK may not work correctly. Use it only if you are certain the Metal API remains compatible with version 2.5.1, or if you are willing to fork and maintain it yourself.

Use it for:

- Index text documents into a Metal instance for later semantic search and retrieval.
- Build a Python application that queries indexed documents through the Metal API without writing raw HTTP calls.
- Prototype document indexing workflows where you need a lightweight, credential-managed client.
- Integrate Metal-powered search into an existing Python application with minimal setup.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Python client library for indexing and querying documents through the Metal API, handling authentication and request serialization.

Yes, if you are actively using the Metal service and the API has not changed since 2023-11-10. The low install friction and permissive license make it straightforward to add. However, the dormant maintenance status means you should verify compatibility with your Metal instance before relying on it in production, and be prepared to maintain a fork if the service has evolved.

## Install

pip install metal-sdk
uv add metal-sdk
poetry add metal-sdk

## Installing metal-sdk

Before you install: Low install friction with only two lightweight runtime dependencies (httpx and typing-extensions). However, the package is dormant—last release was in November 2023—so expect no active maintenance or bug fixes.

License in practice: Licensed under Apache Software License (permissive), so you can use, modify, and distribute it freely in commercial and private projects without restriction.

Quickstart:

pip install metal-sdk

from metal_sdk.metal import Metal

metal = Metal("api_key", "client_id", "index_id")
metal.index({"text": "example document"})

Requires Python 3.7 or later; you must provide valid Metal API credentials (api_key, client_id, index_id) to instantiate the client.

Verify before relying:

- Whether the Metal service API is still actively maintained and compatible with current client versions.
- Whether async support mentioned in examples is fully documented and stable.
- Current status of the getmetal.io service and any breaking changes since the last SDK release.
- Whether the dormant status reflects abandonment of the Metal service itself or just the SDK.

## Package facts

- License: not declared (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: dormant
- Downloads: 129.8K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

metal api python client, document indexing sdk, semantic search sdk, metal.io python wrapper, vector database client, api client library python, document retrieval sdk, api-client, document-indexing

[View on SkillFed](https://skillfed.io/packages/metal-sdk) · [View on PyPI](https://pypi.org/project/metal-sdk/)