> ## Documentation Index
> Fetch the complete documentation index at: https://docs.y.uno/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Test in the sandbox first: base URL https://api-sandbox.y.uno (Test Mode in the Dashboard). Production is https://api.y.uno (Live Mode).
> Every API request needs the public-api-key and private-secret-key headers. Get them in the Dashboard at https://dashboard.y.uno/developers (Developers > Credentials); sandbox and production keys are different.
> Send an X-Idempotency-Key (a UUID) when creating payments, refunds and cancels, so retries do not create duplicates.
> Start with the Quickstart (https://docs.y.uno/docs/quickstart.md) and the agent guide (https://docs.y.uno/agents.md). To search these docs from a coding agent, connect the docs MCP server at https://docs.y.uno/mcp.

# Agent Toolkit

> Crea experiencias de pago con IA con el toolkit multiframework de Yuno.

El Agent Toolkit de Yuno permite que los agentes de IA interactúen con la plataforma de orquestación de pagos de Yuno mediante function calling. Creado para TypeScript, se conecta al servidor MCP remoto de Yuno y expone herramientas de pago que funcionan en cinco frameworks de IA: usa una sola integración para acceder a más de 300 proveedores de pago en todo el mundo.

## Qué incluye

El Yuno Agent Toolkit está disponible como paquete de npm (`@yuno-payments/agent-toolkit`) y ofrece:

* **Integraciones con frameworks**: Vercel AI SDK, Google Genkit, LangChain, OpenAI Chat y OpenAI Agents SDK. Importa solo el adaptador que necesites.
* **Orquestación multiproveedor**: accede a más de 300 proveedores de pago en todo el mundo con una sola integración. Tu agente de IA hereda el enrutamiento inteligente de Yuno, la conmutación por error entre varios proveedores y los métodos de pago específicos de cada mercado.
* **Con tipado seguro**: TypeScript completo con tipos exhaustivos y esquemas validados con Zod.
* **Modular**: importa solo las categorías de herramientas que necesites (clientes, pagos, suscripciones, etc.) y filtra las acciones con detalle.

## Inicio rápido

### Instalación

```bash theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
npm install @yuno-payments/agent-toolkit
```

### Requisitos

* **Node.js**: versión 18 o superior.
* **Cuenta de Yuno**: una [cuenta de Yuno](https://y.uno/) con credenciales de API.

### Credenciales

Obtén tus credenciales de API desde el [Dashboard de Yuno](https://dashboard.y.uno/) y configúralas como variables de entorno:

```bash theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
YUNO_ACCOUNT_CODE=your_account_code
YUNO_PUBLIC_API_KEY=your_public_api_key
YUNO_PRIVATE_SECRET_KEY=your_private_secret_key
```

## Frameworks de IA compatibles

El toolkit ofrece adaptadores especializados para los principales frameworks de IA. Elige el que se ajuste a tu stack:

> [tab] Vercel AI SDK
>
> Importa el adaptador con `@yuno-payments/agent-toolkit/ai-sdk`.
>
> ```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
> import { generateText } from "ai";
> import { openai } from "@ai-sdk/openai";
> import { createYunoAgentToolkit } from "@yuno-payments/agent-toolkit/ai-sdk";
>
> const toolkit = await createYunoAgentToolkit({
>   accountCode: process.env.YUNO_ACCOUNT_CODE!,
>   publicApiKey: process.env.YUNO_PUBLIC_API_KEY!,
>   privateSecretKey: process.env.YUNO_PRIVATE_SECRET_KEY!,
> });
>
> const { text } = await generateText({
>   model: openai("gpt-4o"),
>   tools: toolkit.getTools(),
>   prompt: "Create a customer named Maria Garcia with email maria@example.com",
> });
>
> await toolkit.close();
> ```

> [tab] Google Genkit
>
> Importa el adaptador con `@yuno-payments/agent-toolkit/genkit`.
>
> ```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
> import { genkit, z } from "genkit";
> import { googleAI, gemini15Pro } from "@genkit-ai/googleai";
> import { createYunoGenkitToolkit } from "@yuno-payments/agent-toolkit/genkit";
>
> const ai = genkit({ plugins: [googleAI()] });
>
> const toolkit = await createYunoGenkitToolkit({
>   accountCode: process.env.YUNO_ACCOUNT_CODE!,
>   publicApiKey: process.env.YUNO_PUBLIC_API_KEY!,
>   privateSecretKey: process.env.YUNO_PRIVATE_SECRET_KEY!,
>   ai,
> });
>
> const agent = ai.definePrompt({
>   name: "paymentAgent",
>   model: gemini15Pro,
>   tools: toolkit.getToolsArray(),
>   input: { schema: z.object({ query: z.string() }) },
> });
>
> const result = await agent({ query: "Create a customer named Jane Smith" });
> await toolkit.close();
> ```

> [tab] LangChain
>
> Importa el adaptador con `@yuno-payments/agent-toolkit/langchain`.
>
> ```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
> import { YunoLangChainToolkit } from "@yuno-payments/agent-toolkit/langchain";
>
> const toolkit = await YunoLangChainToolkit.create({
>   accountCode: process.env.YUNO_ACCOUNT_CODE!,
>   publicApiKey: process.env.YUNO_PUBLIC_API_KEY!,
>   privateSecretKey: process.env.YUNO_PRIVATE_SECRET_KEY!,
> });
>
> const tools = toolkit.getTools();
> // Use with LangChain agents...
>
> await toolkit.close();
> ```

> [tab] OpenAI Chat
>
> Importa el adaptador con `@yuno-payments/agent-toolkit/openai`.
>
> ```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
> import OpenAI from "openai";
> import { createYunoOpenAIToolkit } from "@yuno-payments/agent-toolkit/openai";
>
> const toolkit = await createYunoOpenAIToolkit({
>   accountCode: process.env.YUNO_ACCOUNT_CODE!,
>   publicApiKey: process.env.YUNO_PUBLIC_API_KEY!,
>   privateSecretKey: process.env.YUNO_PRIVATE_SECRET_KEY!,
> });
>
> const client = new OpenAI();
> const response = await client.chat.completions.create({
>   model: "gpt-4o",
>   tools: toolkit.getTools(),
>   messages: [{ role: "user", content: "Create a payment link for $50 USD" }],
> });
>
> for (const toolCall of response.choices[0].message.tool_calls ?? []) {
>   const result = await toolkit.handleToolCall(
>     toolCall.function.name,
>     toolCall.function.arguments,
>   );
> }
>
> await toolkit.close();
> ```

> [tab] OpenAI Agents SDK
>
> Importa el adaptador con `@yuno-payments/agent-toolkit/openai-agents`.
>
> ```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
> import { Agent, run } from "@openai/agents";
> import { createYunoOpenAIAgentsToolkit } from "@yuno-payments/agent-toolkit/openai-agents";
>
> const toolkit = await createYunoOpenAIAgentsToolkit({
>   accountCode: process.env.YUNO_ACCOUNT_CODE!,
>   publicApiKey: process.env.YUNO_PUBLIC_API_KEY!,
>   privateSecretKey: process.env.YUNO_PRIVATE_SECRET_KEY!,
> });
>
> const agent = new Agent({
>   name: "Yuno Payment Agent",
>   instructions: "You are a payment assistant powered by Yuno.",
>   tools: toolkit.getTools(),
> });
>
> const result = await run(agent, "Create a customer named Maria Garcia");
> await toolkit.close();
> ```

## Configuración

### Filtrado de acciones

Puedes controlar con detalle qué herramientas están disponibles para el agente:

```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
const toolkit = await createYunoAgentToolkit({
  // ...credentials
  actions: {
    customers: { create: true, retrieve: true },
    payments: { retrieve: true, refund: true },
  },
});
```

Para habilitar todas las herramientas disponibles, puedes usar la constante `ALL_TOOLS_ENABLED`:

```typescript theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
import { ALL_TOOLS_ENABLED } from "@yuno-payments/agent-toolkit/ai-sdk";

const toolkit = await createYunoAgentToolkit({
  // ...credentials
  actions: ALL_TOOLS_ENABLED,
});
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.