How to get started with the Maxim SDK?
Get started with evaluating AI agents accessible via HTTP endpoints using the Maxim SDK. This guide will walk you through setting up the SDK and running your first agent evaluation test run.Installation
First, install the Maxim SDK for your preferred language:Getting Your API Key
Before you can use the Maxim SDK, you need to obtain an API key from the Maxim platform:- Log in to Maxim: Go to app.getmaxim.ai/login and sign in to your account
- Navigate to Settings: Click on âSettingsâ in the left sidebar
- Go to API Keys: Click on âAPI keysâ under âOrganization settingsâ
- Generate New Key: Click the âGenerate newâ button
- Name Your Key: Enter a descriptive name for your API key (e.g., âDevelopmentâ, âCI/CDâ, âLocal Testingâ)
- Copy the Key: Once generated, copy the API key immediately - you wonât be able to see it again
Configuration
Initialize the Maxim SDK with your API key and workspace information:Basic HTTP Agent Test Run
Hereâs how to create and run a basic agent evaluation test run using a workflow stored on the Maxim platform:Next Steps
Now that youâve run your first agent evaluation, explore these guides:- Local Endpoint Testing - Test agents running on your local endpoints
- Endpoint on Maxim - Use workflows stored on the Maxim platform
- Simulation - Run AI-simulated multi-turn conversations
- CI/CD Integration - Automate agent testing in your CI/CD pipeline
Schedule a demo to see how Maxim AI helps teams ship reliable agents.