API Client (Python)

Programmatic access to the Respan REST API from Python.

Install

pip install respan-api

Initialize

from respan_api import RespanClient
client = RespanClient(
authorization="Bearer YOUR_API_KEY",
)

Usage

Spans

# Create a span
span = client.spans.create(
model="gpt-4o",
input='[{"role": "user", "content": "Hello"}]',
output='{"role": "assistant", "content": "Hi!"}',
log_type="chat",
)
# List spans
spans = client.spans.list(
operator="AND",
filters={"model": {"operator": "", "value": ["gpt-4o"]}},
)

Prompts

# List prompts
prompts = client.prompts.list()
# Create a prompt
prompt = client.prompts.create(
name="customer-support",
description="Support chatbot prompt",
)
# Create a version
version = client.prompts.create_prompt_version(
prompt_id="prompt_abc123",
messages=[{"role": "system", "content": "You are a helpful {{role}}."}],
model="gpt-4o",
)
# Deploy a version
client.prompts.deploy_prompt_version(
prompt_id="prompt_abc123",
version=3,
)

Evaluators

# Create an evaluator
evaluator = client.evaluators.create(
name="Response Quality",
type="llm",
score_value_type="numerical",
llm_config={
"model": "gpt-4o-mini",
"evaluator_definition": "Rate the quality: {{input}} {{output}}",
},
)
# Run an evaluator
client.evaluators.run(
evaluator_id="eval_abc123",
dataset_id="ds_abc123",
)

Scores

# Create a score on a span
client.scores.create_span_score(
log_id="log_abc123",
evaluator_slug="quality",
numerical_value=4.5,
)

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