API Client (Python)
API Client (Python)
Programmatic access to the Respan REST API from Python.
Install
pip install respan-api
Initialize
from respan_api import RespanClientclient = RespanClient(authorization="Bearer YOUR_API_KEY",)
Usage
Spans
# Create a spanspan = client.spans.create(model="gpt-4o",input='[{"role": "user", "content": "Hello"}]',output='{"role": "assistant", "content": "Hi!"}',log_type="chat",)# List spansspans = client.spans.list(operator="AND",filters={"model": {"operator": "", "value": ["gpt-4o"]}},)
Prompts
# List promptsprompts = client.prompts.list()# Create a promptprompt = client.prompts.create(name="customer-support",description="Support chatbot prompt",)# Create a versionversion = client.prompts.create_prompt_version(prompt_id="prompt_abc123",messages=[{"role": "system", "content": "You are a helpful {{role}}."}],model="gpt-4o",)# Deploy a versionclient.prompts.deploy_prompt_version(prompt_id="prompt_abc123",version=3,)
Evaluators
# Create an evaluatorevaluator = 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 evaluatorclient.evaluators.run(evaluator_id="eval_abc123",dataset_id="ds_abc123",)
Scores
# Create a score on a spanclient.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.
| Section | Methods |
|---|---|
| Spans | create, list, retrieve, update, get_summary, ingest |
| Traces | create, list, retrieve, delete, get_summary, bulk_delete |
| Users | list, retrieve, update, delete |
| Gateway | create_chat_completion, create_response |
| Prompts | create, list, retrieve, update, delete, create_prompt_version, deploy_prompt_version |
| Evaluators | create, list, retrieve, update, delete, run |
| Datasets | create, list, retrieve, update, delete |
| Scores | create, list, retrieve, update, delete, create_span_score |
| Experiments | create, list, retrieve, delete |
| Models | list, create_custom_model, retrieve_custom_model |