Ingram Cloud

Documentation

Ecosystem & compatibility

Ecosystem & compatibility

Ingram Cloud integrates over industry standards, not a proprietary protocol. Wherever a standard exists, the API speaks it — OpenAI Chat Completions and Responses, the Model Context Protocol for tools, the Vercel AI SDK, and the major model providers. So you keep the SDK, the tools, and the channels you already use; a smith just slots in.

The one place that isn't a standard is the native run envelope, and it exists only for what no standard expresses yet (live tool-progress frames) — see the native surface. Everything else on this page is a standard you already know.

This page is the map. Each surface has its own deep-dive — here is how they fit together, grouped by what you're trying to do.

Drive a smith from your code

You call Ingram Cloud; the smith runs the agent loop server-side — its agent's instructions, tools, memory, and approvals — and streams the result back. Every surface below drives the same run loop, so the smith, its memory, and its tools behave identically; only the wire framing differs. Pick the one that matches the stack you already have.

SurfaceReach for it whenPackageRead
OpenAI Chat Completionsyou have an OpenAI integration, or use any OpenAI SDKopenaiOpenAI-compatible API
OpenAI Responses APIyou want the Responses wire, or server-held conversationsopenaiConversations
Vercel AI SDKyou build with ai / useChat and want a drop-in provider@ingram-tech/ai-sdk-adapterVercel AI SDK
Flueyou build durable agents with the Flue harness@ingram-tech/flue-ingram-cloudFlue
eveyou build agents with Vercel's eve framework@ingram-tech/eve-ingram-cloudeve
Native runs + SSEyou need live tool.executing / tool.completed frames@ingram-tech/ai-sdk-adapter/nativeRuns & streaming
TypeScript wire SDKyou want typed request/response schemas to build against@ingram-tech/ingram-cloud-sdkWire SDK

A smith token is browser-safe and names exactly one smith; a tenant-admin token is server-side only and names the smith per request. See Auth & tokens.

The native surface

The OpenAI-compatible surface is the primary path and carries almost everything. The native run envelope (POST /v1/smiths/{id}/runs, a { "v": 1 } SSE stream) adds the one thing the standard wire doesn't yet: live tool-progress frames while a run works. Reach for it only when you need those; otherwise prefer a standard surface above. Details in Runs & streaming.

Reach your users where they are

Deploy a smith or agent to a messaging channel and Ingram Cloud runs it on every inbound message — the reply returns to the same conversation, on the same thread. You configure the channel once; there is no run loop to host and no webhook to write.

ChannelWhat an inbound message does
Slack · Telegram · WhatsApp · Emailwakes the bound smith (or mints one per sender from an agent) and replies in-channel

A deployment targets either a fixed smith or an agent that mints a fresh smith per sender — the pattern that gives each end-user their own isolated instance automatically. All of it, plus cron schedules, is in Deployments & schedules.

Give a smith tools and models

A smith reaches outward for the model it thinks with and the tools it calls.

  • Models — bring your own key. Pick the provider and model per agent: OpenAI, Anthropic, or Gemini. Move between them without touching your code; hosted models work out of the box if you'd rather not manage keys.
  • Tools over MCP. Register any MCP server and its tools become available to the smith — Ingram Cloud is the MCP client, calling your server and running the tools for you, with optional human approval gating. A curated catalog of common integrations ships ready to enable.
  • Hosted tools. In-process tool bundles (calculation, reasoning, channel actions) a smith can use with no server to run.

See Tools & approvals.

Plug Ingram into other systems

The mirror image of the above: Ingram Cloud as a building block inside someone else's stack.

ConnectorWhat it doesRead
MCP serverexpose a smith as a tool to Claude Desktop, an IDE agent, or another framework — Ingram Cloud is the MCP server hereDeployments
Webhooksevery lifecycle action (run.completed, approval.required, budget alerts) delivered as a signed event to your endpointEvents & webhooks
Pulumi / IaCdeclare agents, MCP servers, integrations, webhooks, and model keys as code — a change is a pulumi upPulumi provider

Not sure which to pick?

You want to…Start with
Add Ingram to an existing OpenAI appOpenAI-compatible API
Embed a chat widget on your siteVercel AI SDK
Build a durable, multi-step agentFlue
Build on Vercel's eve frameworkeve
Answer in Slack / WhatsApp / emailDeployments
Let a smith call your internal toolsTools & approvals
Let another agent call your smithMCP server
Manage everything as codePulumi provider