@soledgic/ai

Pre-built Soledgic tools for the Vercel AI SDK. Give AI agents native access to platform payments, wallet balances, creator payouts, and checkout sessions — without writing any glue code.

Installation

npm install @soledgic/ai @soledgic/sdk ai zod

Usage

import { generateText } from 'ai'
import { openai } from '@ai-sdk/openai'
import { soledgicTools } from '@soledgic/ai/vercel'

const result = await generateText({
  model: openai('gpt-4o'),
  tools: soledgicTools({ apiKey: process.env.SOLEDGIC_API_KEY }),
  maxSteps: 5,
  prompt: 'Check if creator_maya is eligible for a payout and request one if she is.',
})

The model will automatically call checkPayoutEligibility and then requestPayout in sequence — no manual orchestration needed.

Available tools

| Tool | Description | | --- | --- | | createParticipant | Create or update a creator account (idempotent) | | createCheckoutSession | Create a hosted payment page with atomic revenue split | | checkPayoutEligibility | Check if a creator can receive a payout right now | | requestPayout | Initiate an ACH payout to a creator's bank account | | listWallets | List wallet balances for a creator or user | | listWalletActivity | List recent ledger entries for a wallet | | createRefundRequest | Create a buyer-facing refund request | | completeSandboxCheckout | Complete a sandbox checkout without a real processor | | getApiStatus | Check API health and verify the API key |

Example: full marketplace flow

import { generateText } from 'ai'
import { anthropic } from '@ai-sdk/anthropic'
import { soledgicTools } from '@soledgic/ai/vercel'

const tools = soledgicTools({ apiKey: process.env.SOLEDGIC_API_KEY })

// Onboard a creator and create a checkout in one agent call
const { text } = await generateText({
  model: anthropic('claude-sonnet-4-6'),
  tools,
  maxSteps: 10,
  prompt: `
    Onboard a creator with ID "creator_maya", name "Maya Chen", email "[email protected]",
    and a 90% revenue split. Then create a $50 checkout session for a product called
    "UX Course" with success URL https://example.com/success.
    Return the checkout URL.
  `,
})

console.log(text) // → "Here is the checkout URL: https://checkout.soledgic.com/..."

Idempotency

• createParticipant — idempotent by externalCreatorId
• requestPayout — pass a stable referenceId; same value on retry won't duplicate
• createRefundRequest — pass a stable idempotencyKey
• completeSandboxCheckout — pass a stable idempotencyKey

Never generate a new ID on retry. Use the same one from the original call.

Sandbox

Use test keys (slk_test_*) for development. completeSandboxCheckout simulates a successful payment without contacting a real processor — use it to test your full agent flow end to end.

const tools = soledgicTools({ apiKey: 'slk_test_your_key' })

Get a free test key at soledgic.com/signup.

Security

This package makes HTTPS requests to api.soledgic.com only when a tool is invoked. It does not perform background calls, telemetry, or analytics.

Never expose your API key to the browser. Always call these tools from a server-side environment.