Loom

Two integration modes

Direct

The browser talks to Patchwork. You mint a short-lived session token on your backend. Best when the agent is in your product UI.

Relay

Your backend talks to Patchwork with a workspace API key. Best for Slack, WhatsApp, email, or any channel you already own.

Same agents. Same traces. Same patches. Different caller.

Objects

Object	What it is
Connection	A named egress host — where Patchwork calls your tools. Created in the dashboard.
Agent	The operated assistant you authored — model, patches, tools, guardrails. Public id is `agent_…`.
Thread	One conversation. Belongs to a subject (your user). Id is a UUID.
Run	One turn of that conversation. Has a state and a trace. Id is a UUID.
Patch	A capability the agent can use — a catalog tool, or a tool you host.

State	Meaning
`running`	The agent is working.
`awaiting_input`	The agent asked a question. Post the next message on the same thread.
`awaiting_outcome`	The agent called a tool you host. Confirm what happened.
`closed`	The turn finished.
`failed`	The turn failed.

State

Meaning

running

The agent is working.

awaiting_input

The agent asked a question. Post the next message on the same thread.

awaiting_outcome

The agent called a tool you host. Confirm what happened.

closed

The turn finished.

failed

The turn failed.

React SDK

If the agent lives in a React app, start with @usepatchwork/react:

import { PatchworkProvider, useAgent } from "@usepatchwork/react";

<PatchworkProvider
  url="https://api.usepatchwork.co"
  mint={async () => {
    const res = await fetch("/patchwork/mint", { method: "POST" });
    const { data } = await res.json();
    return data.token;
  }}
>
  <Chat />
</PatchworkProvider>

useAgent opens a thread, posts messages, and streams the run over Pusher. You still mint the session token on your backend — the SDK does not hold a workspace key.

The SDK is the fastest path for a product UI. Direct and relay are the HTTP contracts if you are not on React, or if you need a channel Patchwork does not render.

Get started

Workbench

Loom

Two integration modes

Direct

Relay

Objects

Run states

React SDK

​Two integration modes

Direct

Relay

​Objects

​Run states

​React SDK

Two integration modes

Objects

Run states

React SDK