Skip to main content
Freeplay provides multiple integration paths depending on your stack and needs. This page helps you understand how they fit together and choose the right approach.

Integration Philosophy

Freeplay follows a layered approach:
  1. HTTP API - The foundation. All Freeplay functionality is accessible via REST endpoints.
  2. Native SDKs - Language-specific bindings for common operations (Python, TypeScript, Java/Kotlin).
  3. Framework Integrations - Packages optimized for specific AI frameworks (LangGraph, Vercel AI SDK, Google ADK).
  4. OpenTelemetry - For observability with OTel-compatible frameworks where Freeplay lacks a direct integration.
The SDKs are designed for core Freeplay functionality that is likely in your production code path: fetching prompts, recording completions, and executing tests. The API provides a superset of functionality for automation, bulk operations, and advanced use cases. OpenTelemetry provides observability only—use it alongside the SDK or API for prompt management.

Freeplay SDKs

Native SDKs for direct integration with full control over prompt management, observability, and testing / evaluation. What the SDKs provide:
  • Fetch and format prompt templates with variable interpolation
  • Record completions, traces, and sessions for observability
  • Execute batch tests using saved datasets
  • Add customer feedback to observability logs
View SDK documentation →

AI Framework Integrations

For teams using popular AI frameworks, dedicated integration packages provide simplified, automatic observability and streamlined prompt management.
IntegrationLanguageObservabilityPrompt ManagementBest For
LangGraphPython onlyAutomatic tracingFull supportLangGraph agents
Vercel AI SDKTypeScriptAutomatic tracingFull supportTypeScript/JS AI applications
Google ADKPythonAutomatic tracingFull supportGoogle ADK agents
OpenTelemetryAny”AI centric” OTelNot included (use SDKs)Vendor agnostic / custom frameworks
OpenTelemetry integration provides observability only. For prompt management with OTel-traced applications, use the Freeplay SDK alongside your OTel instrumentation.

HTTP API

The REST API provides programmatic access to all Freeplay capabilities. Use the API when you need:
  • Operations not covered by the SDK (e.g. bulk uploads, search, statistics)
  • Integration with languages without a native SDK
  • Additional automation and scripting

API Reference

Complete HTTP API documentation with authentication, endpoints, and interactive playground

Code Recipes

Complete, runnable examples for common integration patterns. Use these as starting points.

Code Recipes

Browse examples for prompts, chat, tool calling, providers, and testing

Choosing Your Integration

Your SituationRecommended Path
New, custom application in Python/TypeScript/JavaStart with the Freeplay SDK
New, custom application in other languages (Go, Ruby, etc.)Use the HTTP API directly
Building with LangGraph in PythonUse the LangGraph integration
Using Vercel AI SDKUse the Vercel AI SDK integration
Using Google ADKUse the ADK integration
Using another OTel-compatible framework (LlamaIndex, etc.) or prefer OTelOpenTelemetry for observability + SDK for prompts
Need additional bulk operations or automationHTTP API directly
Want working examplesBrowse Code Recipes

MCP integration & Freeplay Skills

These tools are experimental and subject to change. Use only with trusted agents, as they provide access to your Freeplay API credentials.
For teams using Claude Code, Cursor, Claude Desktop, or similar, Freeplay provides experimental integrations that enable AI agents to interact directly with your Freeplay workspace through natural language. What these tools enable:
  • Analyze production logs and diagnose quality issues through conversation
  • Iterate on prompts and agent configurations using real production data
  • Run experiments and manage datasets directly from your editor
  • Debug AI systems by exploring traces and sessions interactively
These integrations are ideal for development and debugging workflows, allowing you to explore Freeplay data and iterate on AI systems conversationally. For production integrations, use the SDKs or HTTP API above. See the respective GitHub repositories for installation instructions.

Production Best Practices

Many Freeplay customers configure different client setups for different environments:
  • Dev/Staging: Fetch prompts from the Freeplay server for rapid iteration
  • Production: Use Prompt Bundling to read prompts from local files
This provides fast experimentation in lower environments while ensuring production stability. See Prompt Bundling for implementation details.