API Client (Python)

Programmatic access to the Respan REST API from Python.

Install

$pip install respan-api

Initialize

1from respan_api import RespanClient
2
3client = RespanClient(
4 authorization="Bearer YOUR_API_KEY",
5)

Usage

Spans

1# Create a span
2span = client.spans.create(
3 model="gpt-4o",
4 input='[{"role": "user", "content": "Hello"}]',
5 output='{"role": "assistant", "content": "Hi!"}',
6 log_type="chat",
7)
8
9# List spans
10spans = client.spans.list(
11 operator="AND",
12 filters={"model": {"operator": "", "value": ["gpt-4o"]}},
13)

Prompts

1# List prompts
2prompts = client.prompts.list()
3
4# Create a prompt
5prompt = client.prompts.create(
6 name="customer-support",
7 description="Support chatbot prompt",
8)
9
10# Create a version
11version = client.prompts.create_prompt_version(
12 prompt_id="prompt_abc123",
13 messages=[{"role": "system", "content": "You are a helpful {{role}}."}],
14 model="gpt-4o",
15)
16
17# Deploy a version
18client.prompts.deploy_prompt_version(
19 prompt_id="prompt_abc123",
20 version=3,
21)

Evaluators

1# Create an evaluator
2evaluator = client.evaluators.create(
3 name="Response Quality",
4 type="llm",
5 score_value_type="numerical",
6 llm_config={
7 "model": "gpt-4o-mini",
8 "evaluator_definition": "Rate the quality: {{input}} {{output}}",
9 },
10)
11
12# Run an evaluator
13client.evaluators.run(
14 evaluator_id="eval_abc123",
15 dataset_id="ds_abc123",
16)

Scores

1# Create a score on a span
2client.scores.create_span_score(
3 log_id="log_abc123",
4 evaluator_slug="quality",
5 numerical_value=4.5,
6)

Full API Reference

For all available methods and parameters, see the API Reference.

SectionMethods
Spanscreate, list, retrieve, update, get_summary, ingest
Tracescreate, list, retrieve, delete, get_summary, bulk_delete
Userslist, retrieve, update, delete
Gatewaycreate_chat_completion, create_response
Promptscreate, list, retrieve, update, delete, create_prompt_version, deploy_prompt_version
Evaluatorscreate, list, retrieve, update, delete, run
Datasetscreate, list, retrieve, update, delete
Scorescreate, list, retrieve, update, delete, create_span_score
Experimentscreate, list, retrieve, delete
Modelslist, create_custom_model, retrieve_custom_model