SDKs

Official SDKs wrap the API with typed methods, retries, and sensible defaults, and cover every live endpoint. Clients are available for Node.js/TypeScript, Python, Ruby, and Go. Use the language client instead of raw HTTP when you can.

Install

# Node.js / TypeScript
npm install @synoppy/sdk

# Python
pip install synoppy

# Ruby
gem install synoppy

# Go
go get github.com/Synoppy/synoppy-go

TypeScript

import { Synoppy } from "@synoppy/sdk";

const client = new Synoppy({ apiKey: process.env.SYNOPPY_API_KEY });

const result = await client.read("https://example.com", {
  formats: ["markdown"],
  onlyMainContent: true,
});

console.log(result.markdown);

Python

import os
from synoppy import Synoppy

client = Synoppy(api_key=os.environ["SYNOPPY_API_KEY"])

result = client.read(
    "https://example.com",
    formats=["markdown"],
    only_main_content=True,
)

print(result["markdown"])

Ruby

require "synoppy"

client = Synoppy::Client.new(api_key: ENV["SYNOPPY_API_KEY"])

result = client.read("https://example.com", formats: ["markdown"])

puts result["markdown"]

Go

package main

import (
	"context"
	"fmt"

	"github.com/Synoppy/synoppy-go"
)

func main() {
	client := synoppy.New("YOUR_API_KEY")

	result, err := client.Read(context.Background(), "https://example.com", synoppy.ReadOptions{
		Formats: []string{"markdown"},
	})
	if err != nil {
		panic(err)
	}

	fmt.Println(result.Markdown)
}

Authentication works the same as the HTTP API; read Authentication for key handling.