Skip to content

getting-started.md

Latest commit

 

History

History
90 lines (64 loc) · 1.31 KB

getting-started.md

File metadata and controls

90 lines (64 loc) · 1.31 KB

Getting Started

Installation

Rust

[dependencies]
everruns-sdk = "0.1"

Python

pip install everruns-sdk

TypeScript

npm install @everruns/sdk

Quick Start

1. Set API Key

export EVERRUNS_API_KEY=evr_...

2. Create Client

from everruns_sdk import Everruns

client = Everruns(org="my-org")

3. Create an Agent

agent = client.agents.create(
    name="Assistant",
    system_prompt="You are a helpful assistant."
)

4. Start a Session

session = client.sessions.create(agent_id=agent.id)

4a. Start a Session with Initial Files

from everruns_sdk import InitialFile

session = client.sessions.create(
    agent_id=agent.id,
    initial_files=[
        InitialFile(
            path="/workspace/README.md",
            content="# Demo Project\n",
            encoding="text",
            is_readonly=True,
        )
    ],
)

5. Send a Message

client.messages.create(session.id, text="Hello!")

6. Stream Events

async for event in client.events.stream(session.id):
    if event.type == "output.message.completed":
        print(event.data.message.content)

Next Steps

  • See cookbook/ for practical recipes
  • See specs/ for detailed specifications