AGISTRY DOCUMENTATION
  • Overview
    • Introduction
  • How Agistry works?
  • Roadmap
  • agistry hub
  • Dashboard
  • Create your first Agent
  • Manage your Agents
  • Triggers
  • Adapters & Modules
  • Workflows
  • API Keys
  • Enterprise
  • Framework
    • Core Concepts
    • Getting Started
    • Building and Deploying
  • Execution Model
    • SDK
      • Authentication
      • Adapter Calls
      • Design Flow
    • Adapters
      • Adapter Specification
      • Adapter Schema
      • Adapter Execution
  • Registry
    • Registry Design
    • Capability Matching
  • official links
    • Website
    • GitHub
  • X/Twitter
  • Telegram
Powered by GitBook
On this page
Export as PDF
  1. Framework

Getting Started

This guide will walk you through everything you need to get up and running with Agistry: installing the SDK, discovering adapters, performing your first registry call, and executing off-chain logic.


1. Log in to Agistry Hub

  • Start by visiting Agistry Hub and logging in using your Solana wallet (e.g., Phantom or Backpack):

2. Generate an API Key

  1. Go to the “API Keys” section from the sidebar.

  2. Click “Create API Key”.

  3. Copy your key securely — you'll use it in your backend SDK calls.

Each API key is tied to your account. You can rotate or revoke them at any time.

3. Enable & Configure Adapters

In the “Adapters” tab:

  1. Click “Create Adapter” or select from existing templates.

  2. Choose an adapter type (e.g. pdf-text-extractor, llm-analyzer, telegram-alert)

  3. Configure input fields, default values, and logic

  4. Save and activate it

You can visually define flow order later via UI or just call adapters directly via code.

4. Install the SDK

npm install agistry

5. Your First Adapter Execution

import { AdapterExecutor } from 'agistry';

const agistry = new AdapterExecutor({
  baseUrl: 'https://api.agistry.ai',
  headers: {
    Authorization: `Bearer ${process.env.AGISTRY_API_KEY}`
  }
});

const result = await agistry.run(
  "Analyze this contract for risk. If risky, log and notify ops on telegram.",
  [
    "pdf-text-extractor",
    "llm-analyzer",
    "db-logger",
    "telegram-alert"
  ],
  {
    docUrl: "https://cdn.agistry.ai/uploads/nda.pdf"
  }
);

console.log("📊 Analysis Result:", result.analysis);

Done. What Next?

  • Explore and configure more adapters in Agistry Hub

  • Chain them together into flows

  • Add agents or LLM planners to automate tool usage

  • Monitor execution logs and context in the dashboard

PreviousCore ConceptsNextBuilding and Deploying

Last updated 17 days ago