SDK Overview

Documentation Index

Fetch the complete documentation index at: https://docs.run-agent.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Introduction

​

Available SDKs

​

Python

pip install runagent

​

Rust

cargo add runagent tokio

​

JavaScript

npm install @runagent/sdk

​

Go

go get github.com/runagent-dev/runagent-go

​

Common Features

• Authentication: API key and token management
• Synchronous Calls: Request/response pattern
• Asynchronous Support: Non-blocking operations
• Streaming: Real-time response streaming
• Error Handling: Consistent error types
• Retry Logic: Automatic retry with backoff
• Type Safety: Language-appropriate typing

​

Quick Comparison

​

Basic Usage Pattern

​

Python

from runagent import RunAgentClient

client = RunAgentClient(agent_id="agent-123")
result = client.run_generic({"query": "Hello"})

​

Rust

use runagent::client::RunAgentClient;
use serde_json::json;

let client = RunAgentClient::new("agent-123", "generic", true).await?;
let result = client.run(&[("query", json!("Hello"))]).await?;

​

JavaScript

import { RunAgentClient } from '@runagent/sdk';

const client = new RunAgentClient({ agentId: 'agent-123' });
const result = await client.runGeneric({ query: 'Hello' });

​

Go

import "github.com/runagent-dev/runagent-go"

client := runagent.NewClient("agent-123")
result, err := client.RunGeneric(map[string]interface{}{
    "query": "Hello",
})

​

Authentication

​

Environment Variable

export RUNAGENT_API_KEY="your-api-key"

​

Direct Configuration

client = RunAgentClient(
    agent_id="agent-123",
    api_key="your-api-key"
)

​

Configuration File

{
  "api_key": "your-api-key",
  "api_url": "https://api.run-agent.ai"
}

​

Error Handling

​

Advanced Features

​

Streaming Responses

for chunk in client.run_generic_stream({"query": "Tell a story"}):
    print(chunk, end="")

​

Batch Processing

results = client.batch_run([
    {"query": "Question 1"},
    {"query": "Question 2"},
    {"query": "Question 3"}
])

​

Custom Headers

client = RunAgentClient(
    agent_id="agent-123",
    headers={
        "X-Request-ID": "unique-id",
        "X-User-ID": "user-123"
    }
)

​

SDK Selection Guide

​

Python SDK

• Data science and ML applications
• Backend services
• Scripts and automation
• Jupyter notebooks

​

Rust SDK

• High-performance applications
• Systems programming
• WebAssembly targets
• Memory-efficient applications
• Concurrent processing

​

JavaScript SDK

• Web applications
• Node.js backends
• React/Vue/Angular apps
• Serverless functions

​

Go SDK

• Microservices
• Cloud-native applications
• CLI tools
• Concurrent processing

​

Performance Considerations

​

Migration Guide

1. Client initialization - Same parameters
2. Method names - Consistent across languages
3. Response format - JSON-compatible structures
4. Error handling - Similar error types

​

Getting Help

• Documentation: Language-specific guides
• Examples: GitHub repositories with samples
• Community: Discord channels for each SDK
• Support: [email protected]

​

Next Steps