Skip to content

Files

Latest commit

 

History

History
103 lines (68 loc) · 2.62 KB

introduction.mdx

File metadata and controls

103 lines (68 loc) · 2.62 KB
title description
Welcome to superglue 🍯
Connect to any API without writing complex integration code.

superglue is an API connector that writes its own code. It lets you connect to any API/data source and get the data you want in the format you need. It’s an open source proxy server which sits between you and your target APIs. Thus, you can easily deploy it into your own infra.

Core Functionality

  • Understands schema and format of data source

  • Transforms data sources into your target schema

  • Handles extraction, validation, and transformation automatically

  • Creates deterministic transformation instructions using LLMs

  • Validates output against JSON schemas

  • Supports monitoring, error handling, self-healing out of the box

  • Use as a drop-in replacement for any API integration or as lightweight ETL

Quick Start

  1. Get Access

Get your API key at https://app.superglue.cloud and sign up for early access to the hosted version. Alternatively, you can self-host superglue.

  1. Install the SDK
# Install the SDK
npm install @superglue/client
  1. Make Your First Call
import { SuperglueClient } from "@superglue/client";

const superglue = new SuperglueClient({
  apiKey: "YOUR_API_KEY"
});

// Transform any API response with a single call
const result = await superglue.call({
  endpoint: {
    urlHost: "https://futuramaapi.com",
    instruction: "get all characters from the show from the graphql api",
    documentation: "https://futuramaapi.com/graphql",
    responseSchema: {
      type: "object",
      properties: {
        characters: {
          type: "array",  
          items: {
            type: "object",
            properties: {
              name: { type: "string" },
              species: { type: "string", description: "lowercased" }
            }
          }
        }
      }
    }
  }
});

Next Steps

Requirements

  • Node.js 16+ for the client SDK

  • For self-hosting:

    • Docker 20.10.0+

    • Redis 6.0+

    • OpenAI API key

Support & Resources

Ready to simplify your API integrations? Get started now