sttp-ai: Scala client for OpenAI, Claude, and compatible APIs

sttp is a family of Scala HTTP-related projects, and currently includes:

• sttp client: The Scala HTTP client you always wanted!

• sttp tapir: Typed API descRiptions

• sttp ai: this project. Non-official Scala client wrapper for OpenAI, Claude (Anthropic), and OpenAI-compatible APIs. Use the power of ChatGPT and Claude inside your code!

sttp-ai uses sttp client to describe requests and responses used in OpenAI, Claude (Anthropic), and OpenAI-compatible endpoints.

Getting started

• Quickstart
  • For OpenAI/OpenAI-compatible APIs
  • For Claude (Anthropic) API

OpenAI

• OpenAI API
  • Basic Usage (OpenAI)
• Streaming
  • Create completion with streaming:
• Structured outputs / JSON Schema
  • Lower-level: building ResponseFormat.JsonSchema yourself
  • Deriving a JSON Schema with tapir
  • Generating JSON Schema from case class
• OpenAI-compatible APIs
  • To use Ollama or Grok (OpenAI-compatible APIs)

Claude

• Claude API
  • Claude Features
  • Basic Usage (Claude)
  • Claude Configuration
• Messages API
  • Basic Text Conversation
  • System Messages
  • Image Support
  • Advanced Parameters
• Structured outputs
  • Typed responses with createMessageAs[T]
  • Basic Structured Output Example
  • Manual Schema Definition
• Tool calling
  • Custom Tools
  • Predefined Tools
• Streaming
  • Using fs2 (cats-effect)
  • Using ZIO
  • Using Ox (Scala 3)
• Models, errors and the sync client
  • Claude Models API
  • Claude Error Handling
  • Key Differences from OpenAI API
  • Synchronous Claude Client

Agent loop

• Agent loop
  • Quick Start
• Agent configuration
  • Agent Configuration
  • Hooks
  • Exception Handling
• Agent tools and results
  • Agent Result
  • Typed responses with runAs[T]

Other

• Backends and effect systems
  • Custom Backend
  • Effect Systems
• Running examples