Official SDK clients for the Scope Platform.

Scope SDKs provide read-only access to the Scope Platform, enabling you to:

• Fetch production and draft prompts
• Render prompts with variable substitution
• Cache prompts for performance
• Integrate with your LLM workflows

Install from git (not yet published to PyPI):

pip install git+https://github.com/base14/scope-sdk.git#subdirectory=sdks/python

from scope_client import ScopeClient, ApiKeyCredentials

# Create credentials from environment variables
credentials = ApiKeyCredentials.from_env()
# Or explicitly:
# credentials = ApiKeyCredentials(
#     org_id="my-org",
#     api_key="key_abc123",
#     api_secret="secret_xyz"
# )

# Create a client
client = ScopeClient(credentials=credentials)

# Fetch and render a prompt (defaults to production version)
version = client.get_prompt_version("my-prompt")
rendered = version.render(customer_name="Alice", product="Widget")

# Access prompt metadata (model config, etc.)
model = version.get_metadata("model")  # e.g., "gpt-4"
temperature = version.get_metadata("temperature", 0.7)  # with default

Add to your Gemfile (not yet published to RubyGems):

gem 'scope-client', git: 'https://github.com/base14/scope-sdk.git', glob: 'sdks/ruby/*.gemspec'

require 'scope_client'

# Create credentials from environment variables
credentials = ScopeClient::Credentials::ApiKey.from_env
# Or explicitly:
# credentials = ScopeClient::Credentials::ApiKey.new(
#   org_id: 'my-org',
#   api_key: 'key_abc123',
#   api_secret: 'secret_xyz'
# )

# Configure globally
ScopeClient.configure do |config|
  config.credentials = credentials
end

# Create a client
client = ScopeClient.client

# Fetch and render a prompt (defaults to production version)
version = client.get_prompt_version('my-prompt')
rendered = version.render(customer_name: 'Alice', product: 'Widget')

# Access prompt metadata (model config, etc.)
model = version.get_metadata('model')  # e.g., 'gpt-4'
temperature = version.get_metadata('temperature', 0.7)  # with default

All SDKs use JWT-based authentication with an extensible credentials system. The primary authentication method uses API key credentials.

Authentication requires three values:

1. Organization ID (SCOPE_ORG_ID): Your organization identifier
2. API Key (SCOPE_API_KEY): Your API key ID
3. API Secret (SCOPE_API_SECRET): Your API key secret

These can be loaded from environment variables using ApiKeyCredentials.from_env() (Python) or Credentials::ApiKey.from_env (Ruby), or passed directly when creating credentials.

Generate API keys from the Scope UI under Settings > Applications.

export SCOPE_ORG_ID="my-org"
export SCOPE_API_KEY="key_abc123"
export SCOPE_API_SECRET="secret_xyz"
export SCOPE_API_URL="https://api.scope.io"
export SCOPE_AUTH_API_URL="https://auth.scope.io"

• Ruby SDK Documentation
• Python SDK Documentation
• API Reference

BSD-3-Clause. See LICENSE.