SDKs

The official SDKs wrap the token API so your own code can save and read pastes, organize collections, sync env groups and check account usage. Both are small, MIT-licensed and cover the same operations, so pick the one that matches your runtime.

Quick startCopy Anchor Link

Create a token in Settings > API tokens (see API tokens) and export it as SNIPTIDE_TOKEN. Then check that it works with me, which reads your account and changes nothing:

npm install @sniptide/sdk

import { SniptideClient } from "@sniptide/sdk"

const client = new SniptideClient(process.env.SNIPTIDE_TOKEN!)
const { user, scopes } = await client.me()
console.log(user.name, scopes)

The script prints your display name and the token's access, such as Ada [ "read", "write" ] in Node.js or Ada ['read', 'write'] in Python. A SniptideError with the code unauthorized means the token is missing, wrong, expired or revoked.

How the SDKs behaveCopy Anchor Link

Both clients follow the same rules, so code ports between them with only the naming changed.

• One method per endpoint. Each method sends one request to /api/v1 and returns the API's JSON envelope unchanged, such as { paste } or { pastes, nextCursor }. The API reference served at /docs/api on every instance describes each body.
• Your token, your data. A token reaches only your own live pastes, collections and env groups. Read methods need read access, and methods that create or change data need write.
• Server side only. A token acts as you. Load it from server configuration and keep it out of browser bundles, source control and logs.
• No automatic retries. A failed request raises SniptideError and is never sent twice. Create methods take an idempotency key so that you can retry them safely, as API reliability explains.
• Safe transport. The base URL must use HTTPS, except on localhost, 127.0.0.1 and ::1. Redirects are refused, so a token never leaves the instance you chose. Requests time out after 30 seconds, and responses over 64 MiB are rejected.

The SDKs don't wrap batch creates, OAuth sign-in or the browser session API. Use the batch endpoint directly when you need it.

Self-hosted instancesCopy Anchor Link

Point the client at your instance's address, including any path prefix it is served under. The default is https://app.sniptide.com.

const client = new SniptideClient(process.env.SNIPTIDE_TOKEN!, "https://paste.example.com")

For integration tests that write data, use a separate test instance instead of your real account.

ErrorsCopy Anchor Link

Every failure raises SniptideError with a message, the HTTP status, a machine-readable code and, on 429 and 503, the Retry-After value.

A token can make 3,600 requests an hour. See API tokens for the other limits.