API Client (TypeScript)
API Client (TypeScript)
Programmatic access to the Respan REST API from TypeScript.
Install
npm install @respan/respan-api
Initialize
import { RespanClient } from "@respan/respan-api";const client = new RespanClient({authorization: "Bearer YOUR_API_KEY",});
Usage
Spans
// Create a spanconst span = await client.spans.create({model: "gpt-4o",input: '[{"role": "user", "content": "Hello"}]',output: '{"role": "assistant", "content": "Hi!"}',logType: "chat",});// List spansconst spans = await client.spans.list({operator: "AND",filters: { model: { operator: "", value: ["gpt-4o"] } },});
Prompts
// List promptsconst prompts = await client.prompts.list();// Create a promptconst prompt = await client.prompts.create({name: "customer-support",description: "Support chatbot prompt",});// Create a versionconst version = await client.prompts.createPromptVersion("prompt_abc123", {messages: [{ role: "system", content: "You are a helpful {{role}}." }],model: "gpt-4o",});// Deploy a versionawait client.prompts.deployPromptVersion("prompt_abc123", { version: 3 });
Evaluators
// Create an evaluatorconst evaluator = await client.evaluators.create({name: "Response Quality",type: "llm",scoreValueType: "numerical",llmConfig: {model: "gpt-4o-mini",evaluatorDefinition: "Rate the quality: {{input}} {{output}}",},});// Run an evaluatorawait client.evaluators.run("eval_abc123", {datasetId: "ds_abc123",});
Scores
// Create a score on a spanawait client.scores.createSpanScore("log_abc123", {evaluatorSlug: "quality",numericalValue: 4.5,});
Full API Reference
For all available methods and parameters, see the API Reference.
| Section | Methods |
|---|---|
| Spans | create, list, retrieve, update, getSummary, ingest |
| Traces | create, list, retrieve, delete, getSummary, bulkDelete |
| Users | list, retrieve, update, delete |
| Gateway | createChatCompletion, createResponse |
| Prompts | create, list, retrieve, update, delete, createPromptVersion, deployPromptVersion |
| Evaluators | create, list, retrieve, update, delete, run |
| Datasets | create, list, retrieve, update, delete |
| Scores | create, list, retrieve, update, delete, createSpanScore |
| Experiments | create, list, retrieve, delete |
| Models | list, createCustomModel, retrieveCustomModel |