3 min Public API v1 Quickstart

Your first API call,
in three steps.

One token, one curl command, one SDK of your choice. By the end of this page you have a working example and a .env file ready to wire into Grafana, Datadog, or your internal back-office.

Generate a read-only public token

From the Tramya app, open Account → API Keys and click “Create a token”. The token is shown only once - copy it and store it like a secret.

export TRAMYA_TOKEN="tra_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

A public token exposes only aggregated data (counts, titles, snippets) - never the full content of conversations. It can be rotated at any time.

Verify with curl

A ping to /workspace/status returns JSON with project / conversation / memory counts. If you get 200 OK, your token is good.

curl -sS -H "Authorization: Bearer $TRAMYA_TOKEN" \
  https://app.tramya.com/api/v1/public/workspace/status | jq
The response will appear here. Nothing is sent without your click.

Choose your SDK

Three official clients, zero external transport dependencies.

npm install @tramya/sdk

import { TramyaClient } from '@tramya/sdk';
const tramya = new TramyaClient({ token: process.env.TRAMYA_TOKEN });
const status = await tramya.workspace.status();
console.log(status);

Logical next steps

What to do in the next 15 minutes.

Limits

What the quickstart doesn’t show.