# inference shell documentation

> complete documentation for the inference shell platform.

**URL:** https://inference.sh/docs

---

### getting started

- [introduction](https://inference.sh/docs/getting-started/introduction.md)
- [what is inference shell?](https://inference.sh/docs/getting-started/what-is-inference.md)
- [web app tour](https://inference.sh/docs/getting-started/web-app-tour.md)
- [your first agent](https://inference.sh/docs/getting-started/your-first-agent.md)
### runtime

- [what is a runtime?](https://inference.sh/docs/runtime/overview.md)
- [durable execution](https://inference.sh/docs/runtime/durable-execution.md)
- [observability](https://inference.sh/docs/runtime/observability.md)
- [human-in-the-loop](https://inference.sh/docs/runtime/human-in-the-loop.md)
- [tool orchestration](https://inference.sh/docs/runtime/tool-orchestration.md)
### concepts

- [apps](https://inference.sh/docs/concepts/apps.md)
- [tasks](https://inference.sh/docs/concepts/tasks.md)
- [flows](https://inference.sh/docs/concepts/flows.md)
- [agents](https://inference.sh/docs/concepts/agents.md)
- [workers](https://inference.sh/docs/concepts/workers.md)
- [sessions](https://inference.sh/docs/concepts/sessions.md)
- [search](https://inference.sh/docs/concepts/search.md)
### agents

- [overview](https://inference.sh/docs/agents/overview.md)
- [creating an agent](https://inference.sh/docs/agents/creating.md)
- [system prompts](https://inference.sh/docs/agents/system-prompts.md)
- [skills](https://inference.sh/docs/agents/skills.md)
- [adding tools](https://inference.sh/docs/agents/adding-tools.md)
- [sub-agents](https://inference.sh/docs/agents/sub-agents.md)
- [chatting](https://inference.sh/docs/agents/chatting.md)
- [webhooks](https://inference.sh/docs/agents/webhooks.md)
- [publishing](https://inference.sh/docs/agents/publishing.md)
#### widgets

- [overview](https://inference.sh/docs/agents/widgets/overview.md)
- [schema](https://inference.sh/docs/agents/widgets/schema.md)
- [actions](https://inference.sh/docs/agents/widgets/actions.md)
- [card](https://inference.sh/docs/agents/widgets/card.md)
- [box](https://inference.sh/docs/agents/widgets/box.md)
- [row](https://inference.sh/docs/agents/widgets/row.md)
- [col](https://inference.sh/docs/agents/widgets/col.md)
- [spacer](https://inference.sh/docs/agents/widgets/spacer.md)
- [divider](https://inference.sh/docs/agents/widgets/divider.md)
- [form](https://inference.sh/docs/agents/widgets/form.md)
- [text](https://inference.sh/docs/agents/widgets/text.md)
- [title](https://inference.sh/docs/agents/widgets/title.md)
- [caption](https://inference.sh/docs/agents/widgets/caption.md)
- [label](https://inference.sh/docs/agents/widgets/label.md)
- [markdown](https://inference.sh/docs/agents/widgets/markdown.md)
- [button](https://inference.sh/docs/agents/widgets/button.md)
- [input](https://inference.sh/docs/agents/widgets/input.md)
- [textarea](https://inference.sh/docs/agents/widgets/textarea.md)
- [select](https://inference.sh/docs/agents/widgets/select.md)
- [checkbox](https://inference.sh/docs/agents/widgets/checkbox.md)
- [radio-group](https://inference.sh/docs/agents/widgets/radio-group.md)
- [date-picker](https://inference.sh/docs/agents/widgets/date-picker.md)
- [image](https://inference.sh/docs/agents/widgets/image.md)
- [icon](https://inference.sh/docs/agents/widgets/icon.md)
- [badge](https://inference.sh/docs/agents/widgets/badge.md)
- [chart](https://inference.sh/docs/agents/widgets/chart.md)
- [transition](https://inference.sh/docs/agents/widgets/transition.md)
### skills

- [overview](https://inference.sh/docs/skills/overview.md)
- [creating skills](https://inference.sh/docs/skills/creating.md)
- [the registry](https://inference.sh/docs/skills/registry.md)
- [adding to agents](https://inference.sh/docs/skills/adding-to-agents.md)
- [using with other agents](https://inference.sh/docs/skills/other-agents.md)
### apps

- [overview](https://inference.sh/docs/apps/overview.md)
- [browsing the grid](https://inference.sh/docs/apps/browsing-grid.md)
- [running an app](https://inference.sh/docs/apps/running.md)
- [setup parameters](https://inference.sh/docs/apps/setup-parameters.md)
### artifacts

- [publishing](https://inference.sh/docs/artifacts/publishing.md)
- [capabilities](https://inference.sh/docs/artifacts/capabilities.md)
- [sharing](https://inference.sh/docs/artifacts/sharing.md)
### flows

- [overview](https://inference.sh/docs/flows/overview.md)
- [creating a flow](https://inference.sh/docs/flows/creating.md)
- [connecting nodes](https://inference.sh/docs/flows/connecting.md)
- [deploying as app](https://inference.sh/docs/flows/deploying.md)
### extend

- [overview](https://inference.sh/docs/extend/overview.md)
- [extending apps](https://inference.sh/docs/extend/extending-apps.md)
- [coding agents](https://inference.sh/docs/extend/coding-agents.md)
- [cli setup](https://inference.sh/docs/extend/cli-setup.md)
- [remotes](https://inference.sh/docs/extend/remote.md)
- [creating an app](https://inference.sh/docs/extend/creating-app.md)
- [app code](https://inference.sh/docs/extend/app-code.md)
- [configuration](https://inference.sh/docs/extend/configuration.md)
- [secrets](https://inference.sh/docs/extend/secrets.md)
- [credentials](https://inference.sh/docs/extend/credentials.md)
- [output meta](https://inference.sh/docs/extend/output-meta.md)
- [usage-based pricing](https://inference.sh/docs/extend/pricing.md)
- [best practices](https://inference.sh/docs/extend/best-practices.md)
- [cancellation](https://inference.sh/docs/extend/cancellation.md)
- [troubleshooting](https://inference.sh/docs/extend/troubleshooting.md)
- [deploying](https://inference.sh/docs/extend/deploying.md)
- [multi-function apps](https://inference.sh/docs/extend/multi-function-apps.md)
- [sessions](https://inference.sh/docs/extend/sessions.md)
- [streaming & live functions](https://inference.sh/docs/extend/streaming.md)
### api & sdk

- [overview](https://inference.sh/docs/api/overview.md)
- [authentication](https://inference.sh/docs/api/authentication.md)
#### sdk

- [overview](https://inference.sh/docs/api/sdk/overview.md)
- [running apps](https://inference.sh/docs/api/sdk/running-apps.md)
- [streaming](https://inference.sh/docs/api/sdk/streaming.md)
- [polling](https://inference.sh/docs/api/sdk/polling.md)
- [files](https://inference.sh/docs/api/sdk/files.md)
- [javascript sdk](https://inference.sh/docs/api/sdk-javascript.md)
- [python sdk](https://inference.sh/docs/api/sdk-python.md)
- [swift sdk](https://inference.sh/docs/api/sdk-swift.md)
#### server proxy

- [overview](https://inference.sh/docs/api/sdk/server-proxy.md)
- [next.js](https://inference.sh/docs/api/sdk/proxy/nextjs.md)
- [express](https://inference.sh/docs/api/sdk/proxy/express.md)
- [hono](https://inference.sh/docs/api/sdk/proxy/hono.md)
- [remix](https://inference.sh/docs/api/sdk/proxy/remix.md)
- [sveltekit](https://inference.sh/docs/api/sdk/proxy/sveltekit.md)
- [vercel](https://inference.sh/docs/api/sdk/vercel.md)
#### agent sdk

- [overview](https://inference.sh/docs/api/agent/overview.md)
- [template agents](https://inference.sh/docs/api/agent/template.md)
- [ad-hoc agents](https://inference.sh/docs/api/agent/adhoc.md)
- [building tools](https://inference.sh/docs/api/agent/tools.md)
- [client tools](https://inference.sh/docs/api/agent/client-tools.md)
- [app tools](https://inference.sh/docs/api/agent/app-tools.md)
- [agent tools](https://inference.sh/docs/api/agent/agent-tools.md)
- [webhook tools](https://inference.sh/docs/api/agent/webhook-tools.md)
- [call tools](https://inference.sh/docs/api/agent/call-tools.md)
- [connector tools](https://inference.sh/docs/api/agent/connector-tools.md)
- [internal tools](https://inference.sh/docs/api/agent/internal-tools.md)
- [structured output](https://inference.sh/docs/api/agent/structured-output.md)
- [approval](https://inference.sh/docs/api/agent/approval.md)
- [lifecycle hooks](https://inference.sh/docs/api/agent/lifecycle-hooks.md)
- [streaming](https://inference.sh/docs/api/agent/streaming.md)
#### rest api

- [overview](https://inference.sh/docs/api/rest/overview.md)
- [tasks](https://inference.sh/docs/api/rest/tasks.md)
- [openai compatible](https://inference.sh/docs/api/rest/openai.md)
- [flow runs](https://inference.sh/docs/api/rest/flow-runs.md)
- [flows](https://inference.sh/docs/api/rest/flows.md)
- [sessions](https://inference.sh/docs/api/rest/sessions.md)
- [apps](https://inference.sh/docs/api/rest/apps.md)
- [files](https://inference.sh/docs/api/rest/files.md)
- [agents](https://inference.sh/docs/api/rest/agents.md)
- [publications](https://inference.sh/docs/api/rest/publications.md)
- [embed](https://inference.sh/docs/api/rest/embed.md)
- [triggers](https://inference.sh/docs/api/rest/triggers.md)
- [skills](https://inference.sh/docs/api/rest/skills.md)
- [knowledge](https://inference.sh/docs/api/rest/knowledge.md)
- [artifacts](https://inference.sh/docs/api/rest/artifacts.md)
- [pages](https://inference.sh/docs/api/rest/pages.md)
- [search](https://inference.sh/docs/api/rest/search.md)
- [instances](https://inference.sh/docs/api/rest/instances.md)
- [engines](https://inference.sh/docs/api/rest/engines.md)
- [remotes](https://inference.sh/docs/api/rest/remotes.md)
- [exec runs](https://inference.sh/docs/api/rest/exec-runs.md)
- [entitlements](https://inference.sh/docs/api/rest/entitlements.md)
- [api keys](https://inference.sh/docs/api/rest/api-keys.md)
- [secrets](https://inference.sh/docs/api/rest/secrets.md)
- [vaults](https://inference.sh/docs/api/rest/vaults.md)
- [workspaces](https://inference.sh/docs/api/rest/teams.md)
- [organizations](https://inference.sh/docs/api/rest/orgs.md)
- [usage policy](https://inference.sh/docs/api/rest/usage-policy.md)
- [forms](https://inference.sh/docs/api/rest/forms.md)
- [credentials](https://inference.sh/docs/api/rest/credentials.md)
- [auth providers](https://inference.sh/docs/api/rest/auth-providers.md)
- [mcp servers](https://inference.sh/docs/api/rest/mcp-servers.md)
- [billing](https://inference.sh/docs/api/rest/billing.md)
- [subscription](https://inference.sh/docs/api/rest/subscription.md)
- [usage](https://inference.sh/docs/api/rest/usage.md)
- [store](https://inference.sh/docs/api/rest/store.md)
- [streaming](https://inference.sh/docs/api/rest/streaming.md)
- [magic link](https://inference.sh/docs/api/rest/magic-link.md)
- [device auth](https://inference.sh/docs/api/rest/device-auth.md)
### vault

- [overview](https://inference.sh/docs/secrets/overview.md)
- [credentials](https://inference.sh/docs/secrets/credentials.md)
- [environment variables](https://inference.sh/docs/secrets/environment.md)
### workspaces & organizations

- [overview](https://inference.sh/docs/org/overview.md)
- [workspaces](https://inference.sh/docs/org/teams.md)
- [organizations](https://inference.sh/docs/org/organizations.md)
- [usage policy](https://inference.sh/docs/org/usage-policy.md)
- [api keys](https://inference.sh/docs/org/api-keys.md)
### connectors

- [overview](https://inference.sh/docs/connectors/overview.md)
- [browsing & connecting](https://inference.sh/docs/connectors/browsing.md)
- [using tools](https://inference.sh/docs/connectors/using-tools.md)
- [agent tools](https://inference.sh/docs/connectors/agent-tools.md)
- [mcp server](https://inference.sh/docs/connectors/mcp-server.md)
- [azure devops](https://inference.sh/docs/connectors/azure-devops.md)
### credentials

- [overview](https://inference.sh/docs/credentials/overview.md)
- [google service account](https://inference.sh/docs/credentials/google-service-account.md)
- [google oauth](https://inference.sh/docs/credentials/google-oauth.md)
- [google cloud platform](https://inference.sh/docs/credentials/gcp.md)
- [slack](https://inference.sh/docs/credentials/slack.md)
- [discord](https://inference.sh/docs/credentials/discord.md)
- [x.com](https://inference.sh/docs/credentials/x.md)
- [notion](https://inference.sh/docs/credentials/notion.md)
- [reddit](https://inference.sh/docs/credentials/reddit.md)
- [salesforce](https://inference.sh/docs/credentials/salesforce.md)
- [microsoft](https://inference.sh/docs/credentials/microsoft.md)
- [claude code subscription](https://inference.sh/docs/integrations/claude-code-subscription.md)
### private workers

- [why private?](https://inference.sh/docs/private/why.md)
- [installing the engine](https://inference.sh/docs/private/installing.md)
- [configuration](https://inference.sh/docs/private/config.md)
- [using private workers](https://inference.sh/docs/private/using.md)
- [managing engines](https://inference.sh/docs/private/managing-engines.md)
### examples

- [image generation](https://inference.sh/docs/examples/image-generation.md)
- [audio transcription](https://inference.sh/docs/examples/audio-transcription.md)
- [content pipeline](https://inference.sh/docs/examples/content-pipeline.md)
- [data processing](https://inference.sh/docs/examples/data-processing.md)
- [multi-agent system](https://inference.sh/docs/examples/multi-agent.md)
- [x.com integration](https://inference.sh/docs/examples/x-integration.md)
- [multi-function app](https://inference.sh/docs/examples/multi-function-app.md)
- [stateful sessions](https://inference.sh/docs/examples/stateful-sessions.md)
### policies

- [security](https://inference.sh/docs/policy/security-disclosure.md)
- [providers](https://inference.sh/docs/policy/providers.md)
### devices

- [even realities g2](https://inference.sh/docs/devices/even-g2.md)
