SDKs

Official client libraries for Circa.

ℹ

Coming soon

Official SDKs are in development. Until then, any HTTP client works — examples on every reference page show curl, Node, and Python.

Planned

@circa/sdk — Node / TypeScript
circa-python — Python ≥ 3.9
circa-go — Go ≥ 1.21

Intended ergonomics (Node preview)

import { Circa } from '@circa/sdk';

const circa = new Circa({
  apiKey: process.env.CIRCA_API_KEY!,
  apiVersion: '2026-05-11.arrakis',
});

const me = await circa.me.retrieve();
const { items: teams } = await circa.teams.list();   // every team id you can pass as x-team-id
const { items } = await circa.materials.list({ search: 'polyethylene', limit: 10 });
// Pull the carbon-content row from each material — not whole materials.
for (const material of items) {
  const propertyIds = (material.properties ?? [])
    .filter(p => p.name === 'carbon content')
    .map(p => p.id);
  if (propertyIds.length) {
    await circa.materials.properties.pull(material.id, { propertyIds });
  }
}