Connect an endpoint
Let the copilot call one of your API's endpoints, as the signed-in user, with one sync, or with no agent at all.
Your app calls an API the copilot should use: look up an order, list bookings, change an address.
The app now calls {METHOD /path} to {what it does}. Let the copilot use it as the signed-in user.
Type into What changed? under Sync with code, then paste the prompt it gives you. Works in Claude Code, Cursor, Codex, Windsurf, GitHub Copilot and Gemini CLI.
What the agent will do
- Make it an action Rendel's server calls, when the endpoint is plain HTTPS. That is edited in the console later, with no release.
- Register it in your app's code instead, with
registerAction, only when a server cannot make the call: a Firebase or GraphQL client, signed requests, an internal network, on-device state. - Describe each parameter, and mark anything that changes data as
writeordestructive, so the user confirms it first. - Never send a key. An endpoint that needs a shared API key is saved switched off, for you to add the key.
How to check it worked
The Actions page lists it under On server (or In app code after a build). If it says Add key, enter the key there. On the Test page, pick a user under Talk as and ask for what the endpoint does.
Reference: what it writes
Only for an action that has to run in your app:
Rendel.registerAction(RendelAction(
name: 'cancel_order',
description: 'Cancel an order that has not shipped yet',
params: RendelSchema.object({'order_id': RendelSchema.string()}),
risk: RendelRisk.destructive,
confirmTemplate: 'Cancel order {order_id}? This cannot be undone.',
handler: (params) async => RendelResult.ok({'refund_eta_days': 5}),
));How the sentence becomes one paste: Sync after a change.
Without an agent
On Actions → On server, Connect an API takes an address that works in a browser, or your API's documentation (OpenAPI or Swagger, a YAML spec, a PDF reference, a Postman collection), lists the endpoints, and you tick the ones the copilot may use.
Who the call is made as
| Signed in as | May |
|---|---|
| A shared key, or an account made for the copilot | Read only |
| The signed-in user (your app hands Rendel their token) | Read, and change something after the user confirms |
A change always takes a confirmation card, recorded by the server before it calls your endpoint, once. For the token to reach Rendel, your app has to pass it: see Sign-in and identity. The full rules: Actions and risk levels.