Vendo

https://docs.vendo.run
Admin
Vendo is a platform for building, deploying, and monetizing tenant-facing tools with integrated...
Tokens:153,947
Snippets:1,767
Trust Score:3.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example: Local development setup

Source: https://docs.vendo.run/docs/reference/cli/dev

Demonstrates the typical workflow for local development: generating the environment file, sourcing it, and running the application.

```bash
vendo dev
source .env.vendo-dev
python main.py
```

--------------------------------

### TypeScript Project Setup

Source: https://docs.vendo.run/docs/guides/tutorials/telegram-bot-from-scratch

Initializes a Node.js project, installs Hono and TypeScript dependencies, and configures TypeScript compilation.

```bash
npm init -y
npm install @vendodev/sdk hono
npm install -D typescript tsx @types/node
npx tsc --init --target esnext --module nodenext --moduleResolution nodenext --strict
```

--------------------------------

### Python Project Setup

Source: https://docs.vendo.run/docs/guides/tutorials/telegram-bot-from-scratch

Installs necessary Python packages for a Vendo Telegram bot using FastAPI and Uvicorn. Creates a requirements.txt file.

```bash
python -m venv .venv
source .venv/bin/activate
pip install vendo-sdk fastapi 'uvicorn[standard]'
pip freeze > requirements.txt
```

--------------------------------

### Install Swift SDK

Source: https://docs.vendo.run/docs/changelog/sdk-swift

Instructions for installing the Swift SDK using Swift Package Manager.

```swift
.package(url: "https://github.com/runvendo/vendo-sdk-swift", from: "1.0.0")
```

--------------------------------

### Install @vendodev/sdk

Source: https://docs.vendo.run/docs/getting-started/typescript

Install the Vendo SDK using npm, yarn, or pnpm.

```bash
npm install @vendodev/sdk
# or
yarn add @vendodev/sdk
# or
pnpm add @vendodev/sdk
```

--------------------------------

### Example `deploy_logs` Output

Source: https://docs.vendo.run/docs/deploy-and-publish/operate/logs-and-debugging

This example shows the structured output found in `deploy_logs`, detailing the phases of a deployment workflow and captured container errors on failure.

```text
[deploy-abc123] validate_template           → ok
[deploy-abc123] collect_secrets             → ok (3 generated)
[deploy-abc123] provision_databases         → ok (neon: pg-xyz)
[deploy-abc123] deploy_compute              → ok (railway: project-789)
[deploy-abc123] health_attempt_1            → 503 (boot)
[deploy-abc123] health_attempt_30           → 503 (no response)
[deploy-abc123] health_check_failed         → FAILED (timeout after 300s)
[deploy-abc123] collect_app_logs_on_failure → captured 47 lines
[deploy-abc123]   container stderr: ECONNREFUSED 127.0.0.1:6379
```

--------------------------------

### Database Configuration Examples

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/manifest

Examples of how to define database services, including Neon Postgres and Railway Redis. Note the provider-specific configurations and persistence requirements.

```json
{ "name": "postgres", "type": "postgresql", "provider": "neon",    "region": "aws-us-east-1" }
```

```json
{ "name": "cache",    "type": "redis",      "provider": "railway", "image": "redis:7.2" }
```

--------------------------------

### Install vendo-sdk

Source: https://docs.vendo.run/docs/getting-started/python

Install the vendo-sdk and optional dependencies for HTTP requests or async support.

```bash
pip install vendo-sdk
# Optional: requests-based session helper
pip install "vendo-sdk[http]"
# Optional: async (aiohttp) support
pip install "vendo-sdk[async]"
```

--------------------------------

### Install Vendo CLI

Source: https://docs.vendo.run/docs/reference/cli

Install the Vendo CLI globally using npm and verify the installation with the help command. Requires Node 20 or newer.

```bash
npm install -g @vendodev/cli

```

```bash
vendo --help
```

--------------------------------

### Release Migration Example

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/submission

Example of an INSERT statement for the `tool_releases` table in the release migration. This sets the tool's version and status, and handles existing active releases.

```sql
INSERT INTO tool_releases (tool_id, version, status)
VALUES (
  (SELECT id FROM apps_catalog WHERE slug = '<slug>'),
  '<version>',
  'active'
)
ON CONFLICT (tool_id) WHERE status = 'active'
DO UPDATE SET status = 'inactive';
```

--------------------------------

### Install optional async support

Source: https://docs.vendo.run/docs/getting-started/python

Install the `[async]` extra for optimized asynchronous operations using `aiohttp`. This is optional as `AsyncVendo` can use stdlib `urllib` and `asyncio.to_thread`.

```bash
pip install "vendo-sdk[async]"  # optional; faster HTTP
```

--------------------------------

### GET /api/pricing/integrations Response

Source: https://docs.vendo.run/docs/reference/http-api/tools

Example response for the GET /api/pricing/integrations endpoint, returning a flat list of integrations with public-flagged meters for the sidebar.

```json
{ "integrations": [ { "slug": "openrouter", "name": "OpenRouter", "category": "llm" } ] }
```

--------------------------------

### Example vendo.yaml Configuration

Source: https://docs.vendo.run/docs/reference/vendo-yaml-schema

A complete example of a `vendo.yaml` file showing common fields like name, version, runtime, integrations, environment variables, and health check configuration.

```yaml
name: hermes-bot          # required, slug-like
version: 1                # required, schema version
runtime: python           # optional
integrations:             # optional, integration slugs from the Vendo catalog
  - openai
  - telegram
env:                      # optional
  required:
    - DATABASE_URL
  optional:
    - LOG_LEVEL
health:                   # optional
  path: /healthz
  port: 8080
restart_on:               # optional
  - openai

```

--------------------------------

### Install vendo-sdk Python Package

Source: https://docs.vendo.run/docs/changelog/sdk-python

Install the vendo-sdk Python package to version 1.0.0. PyPI publish is pending organizational approval.

```bash
pip install vendo-sdk==1.0.0
```

--------------------------------

### Install the Vendo TypeScript SDK

Source: https://docs.vendo.run/docs/reference/sdk/typescript

Use npm to install the Vendo SDK. Requires Node 18+ or Deno 1.40+.

```bash
npm install @vendodev/sdk
```

--------------------------------

### Install TypeScript SDK v1.0.0

Source: https://docs.vendo.run/docs/changelog/sdk-typescript

Install the first stable release of the Vendo TypeScript SDK using npm. This command installs version 1.0.0.

```bash
npm install @vendodev/sdk@1.0.0
```

--------------------------------

### Database Seed Migration Example

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/submission

Example of an INSERT statement for the `apps_catalog` table in the database seed migration. This includes required and optional columns for a new tool entry.

```sql
INSERT INTO apps_catalog (
  id, 
  slug, 
  name, 
  tool_type, 
  enabled, 
  featured, 
  usage_category, 
  allowed_callback_patterns, 
  marketing, 
  auth_mode, 
  description, 
  surface_all_connections, 
  supported_connections
) VALUES (
  gen_random_uuid(),
  '<slug>',
  '<name>',
  'deployment', -- or 'service'
  true,
  false,
  'chatbots',
  ARRAY['http://localhost:3000/*'],
  '{"description": "A tool that does X.", "tagline": "Do X easily." }'::jsonb,
  NULL, -- or 'oauth2', 'api_key', etc.
  'A tool that does X.',
  true,
  '[]' -- or a JSONB array of connection names
);
```

--------------------------------

### vendo.reconciler.start

Source: https://docs.vendo.run/docs/reference/sdk/python/reference

Starts the reconciler.

```APIDOC
## POST /reconciler/start

### Description
Starts the reconciler service.

### Method
POST

### Endpoint
`/reconciler/start`
```

--------------------------------

### Example output of vendo whoami

Source: https://docs.vendo.run/docs/reference/cli/whoami

This is an example of the expected output when the command successfully retrieves all information. The balance line may show '(unavailable: <reason>)' if the balance endpoint call fails.

```text
Email:    you@example.com
Tenant:   t_abc
Issued:   2026-05-20T12:00:00Z
API base: https://vendo.run
Balance:  $12.50
```

--------------------------------

### Install Vendo Python SDK

Source: https://docs.vendo.run/docs/reference/sdk/python

Install the Vendo SDK using pip. Optional dependencies for HTTP session helpers (requests) or async support (aiohttp) can be included.

```bash
pip install vendo-sdk
```

```bash
pip install "vendo-sdk[http]"
```

```bash
pip install "vendo-sdk[async]"
```

--------------------------------

### Initialize Vendo Client

Source: https://docs.vendo.run/docs/reference/sdk/typescript/reference

Import and instantiate the Vendo client. This is the starting point for using the SDK.

```typescript
import { Vendo } from "@vendodev/sdk";
const vendo = new Vendo();
```

--------------------------------

### Example 'version' Field

Source: https://docs.vendo.run/docs/reference/vendo-yaml-schema

Sets the manifest schema version. Currently, this must be `1`.

```yaml
version: 1

```

--------------------------------

### Request Example for Events API

Source: https://docs.vendo.run/docs/reference/http-api/events

This is an example of the HTTP request to establish a Server-Sent Events stream for deployment events. Ensure the `Authorization` header uses an App Key and `Accept` is set to `text/event-stream`.

```http
GET /api/deployments/me/events HTTP/1.1
Host: vendo.run
Authorization: Bearer vendo_sk_…
Accept: text/event-stream
Last-Event-ID: <optional id of last received event>
```

--------------------------------

### Example 'name' Field

Source: https://docs.vendo.run/docs/reference/vendo-yaml-schema

Specifies the application name as a required string. It must follow a slug-like format.

```yaml
name: my-cool-tool

```

--------------------------------

### Connected to Deployment Output

Source: https://docs.vendo.run/docs/reference/cli/ssh

This is an example of the success message displayed on stderr when a connection to the deployment is established.

```bash
✓ Connected to support-bot
```

--------------------------------

### List Connections

Source: https://docs.vendo.run/docs/reference/sdk/swift/reference

Fetches a list of all available connections for the current deployment. This corresponds to a GET request to /api/deployments/me/connections.

```swift
try await vendo.connections.list()
```

--------------------------------

### Example Deployment Error Body

Source: https://docs.vendo.run/docs/reference/http-api/deploy

Illustrates the structure of an error response when a deployment slug is already taken.

```json
{
  "message": "A deployment already exists at acme-support-bot.vendo.run. Pick a different slug.",
  "code": "SLUG_TAKEN"
}
```

--------------------------------

### GET /api/tools/catalog Response

Source: https://docs.vendo.run/docs/reference/http-api/tools

Example response for the GET /api/tools/catalog endpoint, listing required and optional integrations.

```json
{
  "required": [
    {
      "integrationId": "00000000-0000-0000-0000-000000000000",
      "provider": "openrouter",
      "name": "OpenRouter",
      "description": "…",
      "iconName": null,
      "logoUrl": "…",
      "category": "llm",
      "defaultProfile": "vendo_managed_pool",
      "supportedProfiles": ["vendo_managed_pool"],
      "alreadyEnabled": true
    }
  ],
  "optional": [
    { "provider": "telegram", "...": "…", "alreadyEnabled": false }
  ]
}
```

--------------------------------

### Initialize Project Directory

Source: https://docs.vendo.run/docs/guides/tutorials/telegram-bot-from-scratch

Sets up a new project directory and initializes a Git repository.

```bash
mkdir my-bot && cd my-bot
git init
```

--------------------------------

### Example: Local development with deployment attribution

Source: https://docs.vendo.run/docs/reference/cli/dev

Shows how to set up local development while attributing usage to a specific deployment, useful when running tools that are already deployed.

```bash
vendo dev --deployment dpl_abc
source .env.vendo-dev
npm start
```

--------------------------------

### GET /api/pricing/public/{slug} Error Response

Source: https://docs.vendo.run/docs/reference/http-api/tools

Example error response for the GET /api/pricing/public/{slug} endpoint when the slug is not found in the public allowlist.

```json
{ "message": "Not found" }
```

--------------------------------

### GET /api/pricing/models Response

Source: https://docs.vendo.run/docs/reference/http-api/tools

Example response for the GET /api/pricing/models endpoint, showing the live OpenRouter model catalog with Vendo's margin applied.

```json
{
  "models": [
    {
      "id": "anthropic/claude-3.5-sonnet",
      "name": "Claude 3.5 Sonnet",
      "context_length": 200000,
      "pricing": {
        "prompt_per_token": 0.0000036,
        "completion_per_token": 0.000018,
        "prompt_per_million": 3.6,
        "completion_per_million": 18.0
      }
    }
  ],
  "cached": false
}
```

--------------------------------

### Handle Telegram Connection Error in Swift

Source: https://docs.vendo.run/docs/guides/recipes/telegram-bot

Catch `VendoError.notConnected` when attempting to get the Telegram token. If disconnected, generate a `connectURL` to direct the user to the integration setup.

```swift
do {
    let token = try await vendo.token("telegram")
} catch VendoError.notConnected(let slug, let message) {
    let url = try vendo.connectURL(slug: slug, returnTo: "https://yourapp.com/settings")
    print("Connect \(slug) first: \(url)")
}
```

--------------------------------

### Create Stripe SetupIntent

Source: https://docs.vendo.run/docs/reference/http-api/billing

Creates a Stripe SetupIntent for saving a payment card.

```APIDOC
## POST /api/billing/setup-intent

### Description
Creates a Stripe SetupIntent for saving a payment card.

### Method
POST

### Endpoint
/api/billing/setup-intent

### Response
#### Success Response (200)
- **client_secret** (string) - The client secret for the Stripe SetupIntent.
```

--------------------------------

### Define Wizard Layout with Sub-steps

Source: https://docs.vendo.run/docs/build-a-tool/vendo-yaml/wizard-inputs

Example of `wizardLayout` in a template manifest, organizing user inputs and integrations into distinct sub-steps within the deployment wizard.

```json
{
  "wizardLayout": {
    "version": 1,
    "subSteps": [
      {
        "id": "connect",
        "title": "Connect integrations",
        "sections": [
          { "type": "integration", "providers": ["openrouter", "telegram"] }
        ]
      },
      {
        "id": "configure",
        "title": "Basic settings",
        "sections": [
          { "type": "wizard_inputs", "groups": ["basic"] }
        ]
      }
    ]
  }
}
```

--------------------------------

### Initialize Vendo SDK

Source: https://docs.vendo.run/docs/reference/sdk/swift/reference

Instantiate the Vendo SDK. API key can be provided directly or will be read from the VENDO_API_KEY environment variable. Falls back to default base URL and API version if not specified.

```swift
import Vendo

let vendo = try Vendo()
```

```swift
let vendo = try Vendo(apiKey: "vendo_sk_...")
```

--------------------------------

### Get Billing Balance

Source: https://docs.vendo.run/docs/reference/sdk/swift/reference

Retrieves the current billing balance. This operation is only available in Vendo mode and corresponds to a GET request to /api/billing/balance.

```swift
try await vendo.billing.balance()
```

--------------------------------

### Reconciler Start

Source: https://docs.vendo.run/docs/reference/sdk/python

Start the reconciler process, specifying the environment file, mapping, and an optional `on_change` behavior (e.g., 'restart', 'reload-hook', or a callable).

```python
# on_change defaults to "restart"; accepts "reload-hook" or a callable.
reconciler = vendo.reconciler.start(
    env_file="/app/.env",
    mapping=lambda: {"X": "1"},
    on_change="restart",
)
```

--------------------------------

### Class-based Client Initialization

Source: https://docs.vendo.run/docs/reference/sdk/python

Instantiate the synchronous `Vendo` client. You can optionally provide an API key and base URL.

```python
from vendo import Vendo, AsyncVendo

client = Vendo(api_key=None, base_url=None)
```

--------------------------------

### Example Wizard Layout Configuration

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/wizard-layout

Defines the structure of the wizard, including sub-steps, sections, and filtering for user inputs and integrations. Use this to organize the tenant's configuration flow.

```json
{
  "wizardLayout": {
    "version": 1,
    "subSteps": [
      {
        "id": "name",
        "title": "Name your deployment",
        "sections": [
          { "type": "deployment_name" },
          { "type": "workspace" }
        ]
      },
      {
        "id": "connect",
        "title": "Connect integrations",
        "sections": [
          { "type": "integration", "providers": ["openrouter", "telegram"] }
        ]
      },
      {
        "id": "configure",
        "title": "Basic settings",
        "sections": [
          { "type": "wizard_inputs", "groups": ["basic"] }
        ]
      },
      {
        "id": "advanced",
        "title": "Advanced",
        "description": "Optional — defaults work for most cases.",
        "optional": true,
        "sections": [
          { "type": "wizard_inputs", "groups": ["*"] },
          { "type": "tool_extras" }
        ]
      }
    ]
  }
}
```

--------------------------------

### Start and Stop the Reconciler

Source: https://docs.vendo.run/docs/reference/sdk/typescript

Start the reconciler with configuration and an optional onChange handler. The reconciler can be stopped using the returned object's stop method.

```typescript
const r = await reconciler.start({
  envFile: "/app/.env",
  mapping: async () => ({ X: "1" }),
  onChange: "restart",   // | "reload-hook" | (diff) => void
});
r.stop();
```

--------------------------------

### Example SSE Stream Output

Source: https://docs.vendo.run/docs/reference/http-api/events

This shows a typical output from the SSE stream, including a `: ping` heartbeat and example event blocks for `connection.connected` and `billing.usage_recorded`.

```text
: ping

id: evt_01H…
event: connection.connected
data: {"id":"evt_01H…","at":"2026-05-20T12:00:00Z","kind":"connection.connected","slug":"openai","connection_id":"cn_…"}

id: evt_01H…
event: billing.usage_recorded
data: {"id":"evt_01H…","at":"2026-05-20T12:00:01Z","kind":"billing.usage_recorded","provider":"openrouter","micros":1234}


```

--------------------------------

### vendo.reconciler.bootstrap

Source: https://docs.vendo.run/docs/reference/sdk/python/reference

Boots the reconciler.

```APIDOC
## POST /reconciler/bootstrap

### Description
Initiates the bootstrap process for the reconciler.

### Method
POST

### Endpoint
`/reconciler/bootstrap`
```

--------------------------------

### Swift: Get token for request

Source: https://docs.vendo.run/docs/concepts/request-scoping

Use `forRequest` in a Vapor request handler to get a Vendo client scoped to the user. Throws `VendoError.identityNotPresent` if `X-Vendo-User-JWT` is absent.

```Swift
import Vapor
import Vendo

func calendarHandler(_ req: Request) async throws -> Response {
    let headers = Dictionary(
        uniqueKeysWithValues: req.headers.map { ($0.name.description, $0.value) }
    )
    let client = try vendo.forRequest(headers: headers)
    let token = try await client.token("google")
    return Response(body: .init(string: token))
}
```

--------------------------------

### Install Vendo SDK

Source: https://docs.vendo.run/docs/reference/sdk/swift

Add the Vendo SDK to your project's Package.swift file and include 'Vendo' in your target's dependencies.

```swift
.package(
    url: "https://github.com/runvendo/vendo-sdk-swift",
    from: "1.0.0"
)
```

--------------------------------

### TypeScript: Get token for request

Source: https://docs.vendo.run/docs/concepts/request-scoping

Use `forRequest` within an Express.js request handler to get a Vendo client scoped to the user. Throws `IdentityNotPresent` if `X-Vendo-User-JWT` is absent.

```TypeScript
import express from "express";
import { Vendo } from "@vendodev/sdk";

const app = express();

app.get("/api/calendar", async (req, res) => {
  const client = new Vendo().forRequest(req.headers);
  const token = await client.token("google");
  res.json({ token });
});
```

--------------------------------

### Browser Entry Point

Source: https://docs.vendo.run/docs/reference/sdk/typescript

Import necessary components and functions for using the SDK in a browser environment, including custom elements.

```APIDOC
## Browser Entry Point
```typescript
import { register, VendoConnectButton, VendoConnectionCard } from "@vendodev/sdk/browser";
```
Custom elements: `<vendo-connect-button>`, `<vendo-connection-card>`.
```

--------------------------------

### Vendo Actor Initialization

Source: https://docs.vendo.run/docs/reference/sdk/swift

Demonstrates how to initialize the `Vendo` actor, either by reading the API key from environment variables or by providing it explicitly. It also shows how to specify a custom base URL.

```APIDOC
## Vendo Actor Initialization

`Vendo` is implemented as a Swift `actor`. The constructor throws `VendoError.auth` if `VENDO_API_KEY` is unset and no `apiKey:` is passed.

```swift
import Vendo

// Vendo mode (reads VENDO_API_KEY from env)
let vendo = try Vendo()

// OSS/BYOK mode — pass an explicit key (any non-empty string opts into the
// instance; per-slug BYOK lookups read provider-conventional env vars).
let vendo = try Vendo(apiKey: "byok")

// Explicit — note no `/api` suffix on baseURL.
let vendo = try Vendo(
    apiKey: "vendo_sk_...",
    baseURL: "https://vendo.run"
)
```

Sub-API properties are `nonisolated`, so synchronous access does not require `await`. Async methods on the actor (e.g. `token`, `forUser`) do.
```

--------------------------------

### Start Reconciler Watcher

Source: https://docs.vendo.run/docs/reference/sdk/typescript/reference

Starts a long-running watcher that polls a mapping function and applies changes to the .env file. Use to keep environment variables synchronized with Vendon connections.

```typescript
import * as reconciler from "@vendodev/sdk/reconciler";

reconciler.start(options: ReconcilerOptions): Promise<Reconciler>
```

```typescript
const r = await reconciler.start({
  envFile: "/app/.env",
  mapping: async () => ({ OPENAI_API_KEY: await vendo.token("openai") }),
  onChange: "restart",
});
// Later:
r.stop();
```

--------------------------------

### Example 'restart_on' Field

Source: https://docs.vendo.run/docs/reference/vendo-yaml-schema

Specifies integration slugs that should trigger a deployment restart when their connection state changes. Useful for apps that cache credentials at boot.

```yaml
restart_on:
  - openai
  - telegram

```

--------------------------------

### Configure Service Start Order

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/manifest

Use `serviceStartOrder` to define the sequence in which services should be deployed. This is required when one service must complete before others can begin, such as an init service running database migrations.

```json
"serviceStartOrder": ["migrate", "web", "worker"]
```

--------------------------------

### Declare User Inputs for Deploy Wizard

Source: https://docs.vendo.run/docs/deploy-and-publish/publish-to-catalog/manifest

Define environment variables that tenants will fill in via the deploy wizard. Specify key, category, label, description, default value, and input type.

```json
"userInputs": [
  {
    "key": "OPENAI_MODEL",
    "category": "user_required",
    "label": "Default model",
    "description": "Used for chat completions",
    "default": "gpt-4o-mini",
    "inputType": "text"
  }
]
```

--------------------------------

### Start Reconciler Watcher

Source: https://docs.vendo.run/docs/reference/sdk/python/reference

Starts a long-running watcher that synchronizes the .env file with active connections. It can optionally trigger a restart or a reload hook when changes are detected. The on_change parameter can be set to 'restart', 'reload-hook', or a custom callable.

```python
mapping, restart_factory = vendo.reconciler.catalog_default()
reconciler = vendo.reconciler.start(
    env_file="/app/.env",
    mapping=mapping,
    on_change=restart_factory(gateway=lambda: os.kill(os.getpid(), signal.SIGHUPAINLESS))
)
reconciler.stop()
```

--------------------------------

### Login to Non-Production Instance

Source: https://docs.vendo.run/docs/reference/cli/login

Use the `--api-base` flag to specify a different Vendo instance URL, such as a staging environment.

```bash
vendo login --api-base https://staging.vendo.run
```

--------------------------------

### Get Deployable Tools

Source: https://docs.vendo.run/docs/reference/http-api/tools

Retrieves a list of tools that can be deployed.

```APIDOC
## GET /api/tools/deployable

### Description
Retrieves a list of tools that can be deployed.

### Method
GET

### Endpoint
/api/tools/deployable

### Response
#### Success Response (200 OK)
Returns a list of deployable tools.
```

--------------------------------

### Get Tools Catalog

Source: https://docs.vendo.run/docs/reference/http-api/tools

Retrieves a catalog of available tools.

```APIDOC
## GET /api/tools/catalog

### Description
Retrieves a catalog of available tools.

### Method
GET

### Endpoint
/api/tools/catalog

### Response
#### Success Response (200 OK)
Returns a list of tools available in the catalog.
```

--------------------------------

### Example: .env.vendo-dev file content

Source: https://docs.vendo.run/docs/reference/cli/dev

Shows the structure and typical content of the generated `.env.vendo-dev` file, including Vendo credentials and provider proxy information.

```dotenv
# Generated by 'vendo dev'. Do not commit.
# Issued at: 2026-05-20T12:00:00Z

VENDO_API_KEY=vendo_sk_…
VENDO_TENANT_ID=t_…
VENDO_DEPLOYMENT_ID=dpl_…   # only if --deployment was passed

# Per-provider proxy URLs (real prod proxy, real billing).
OPENROUTER_API_KEY=vendo_sk_…
OPENROUTER_BASE_URL=https://openrouter-proxy.vendo.run/v1

ELEVENLABS_API_KEY=vendo_sk_…
ELEVENLABS_BASE_URL=https://elevenlabs-proxy.vendo.run/v1
```

--------------------------------

### Get Tool Integrations

Source: https://docs.vendo.run/docs/reference/http-api/tools

Retrieves a list of integrations associated with a specific tool.

```APIDOC
## GET /api/tools/{slug}/integrations

### Description
Retrieves a list of integrations associated with a specific tool.

### Method
GET

### Endpoint
/api/tools/{slug}/integrations

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier (slug) of the tool.

### Response
#### Success Response (200 OK)
Returns a list of integrations for the specified tool.
```

--------------------------------

### Create App Binding (200 OK)

Source: https://docs.vendo.run/docs/reference/http-api/apps

Response when successfully creating a binding for an app. Indicates if the binding already existed and if a restart is required.

```json
{
  "ok": true,
  "connection_id": "00000000-0000-0000-0000-000000000000",
  "already_connected": false,
  "restartRequired": true
}
```

--------------------------------

### Get Stripe Customer Profile

Source: https://docs.vendo.run/docs/reference/http-api/billing

Fetches a snapshot of the Stripe customer profile.

```APIDOC
## GET /api/billing/customer

### Description
Fetches a snapshot of the Stripe customer profile.

### Method
GET

### Endpoint
/api/billing/customer

### Response
#### Success Response (200)
- **customer_profile** (object) - An object containing the Stripe customer profile details.
```

--------------------------------

### Insert Tool with Pricing

Source: https://docs.vendo.run/docs/pricing-and-revenue/setting-your-pricing

This SQL snippet demonstrates how to insert a new tool into the `tools` table, specifying the `marketing` object with a `pricing` field set to 'credits'.

```sql
INSERT INTO tools (slug, name, ..., marketing) VALUES (
  'my-tool',
  'My Tool',
  ...,
  jsonb_build_object(
    'pricing',     'credits',
    'replaces',    'HubSpot, Salesforce',
    'monthlyCost', '~$15/mo for a typical workload'
  )
);
```

--------------------------------

### Get Tenant Usage Rollup

Source: https://docs.vendo.run/docs/reference/http-api/billing

Retrieves a rollup of tenant-level usage data.

```APIDOC
## GET /api/billing/usage

### Description
Retrieves a rollup of tenant-level usage data.

### Method
GET

### Endpoint
/api/billing/usage

### Response
#### Success Response (200)
- **usage** (object) - An object containing various usage metrics.
```

--------------------------------

### Get Integration by Slug

Source: https://docs.vendo.run/docs/reference/sdk/python/reference

Retrieves a single integration using its unique slug identifier.

```python
Vendo.integrations.get(slug: str) -> Integration | None
```

--------------------------------

### Vendo Class Initialization

Source: https://docs.vendo.run/docs/reference/sdk/typescript

Instantiate the Vendo client with optional configuration. It can use environment variables for API key and base URL if not provided.

```APIDOC
## Vendo Class
```typescript
import { Vendo } from "@vendodev/sdk";

const vendo = new Vendo({
  apiKey?: string,      // defaults to process.env.VENDO_API_KEY
  baseUrl?: string,     // defaults to process.env.VENDO_BASE_URL || "https://vendo.run"
  apiVersion?: string,  // defaults to "2026-05-02"
});
```
The constructor throws `AuthError` if `VENDO_API_KEY` is not in env and `apiKey` is not passed.
```

--------------------------------

### Standard Login

Source: https://docs.vendo.run/docs/reference/cli/login

Use this command for a standard login process. It will open your browser to authorize the CLI.

```bash
vendo login
```

--------------------------------

### Get Known BYOK Slugs

Source: https://docs.vendo.run/docs/reference/sdk/swift

Retrieve a set of all known BYOK integration slugs.

```swift
BYOK.knownSlugs()                  // Set<String>
```

--------------------------------

### Clone and Develop Vendo CLI

Source: https://docs.vendo.run/docs/reference/cli

Steps to clone the Vendo CLI repository, install dependencies, and run tests for local development. Includes a smoke test command.

```bash
git clone git@github.com:runvendo/vendo-cli.git
```

```bash
cd vendo-cli
```

```bash
npm install
```

```bash
npm test
```

```bash
npm run smoke   # `vendo --help`
```

--------------------------------

### Get Integration by Slug

Source: https://docs.vendo.run/docs/reference/sdk/swift

Asynchronously retrieve a specific integration by its slug. Requires `await`.

```swift
try await vendo.integrations.get(slug: String) -> Integration?
```

--------------------------------

### Get Connection by Slug

Source: https://docs.vendo.run/docs/reference/sdk/swift

Asynchronously retrieve a specific connection by its slug. Requires `await`.

```swift
try await vendo.connections.get(slug: String) -> Connection?
```
Tokens:
Raw