Model endpoint

The browser never holds your API key. A server route you own does.

openAICompatible({ endpoint }) posts JSON to a URL on your own origin. That route forwards the request to the model provider and adds the credentials.

CAUTION

Never call a model provider straight from browser code. Anyone who opens DevTools can read the key, and anyone who reads the key can spend your money.

What the browser sends

The adapter posts the transcript and the tool definitions it discovered on the page:

{
  "messages": [{ "role": "user", "content": "create a project called Phoenix" }],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "createProject",
        "description": "Create a project.",
        "parameters": { "type": "object", "properties": { "name": { "type": "string" } } }
      }
    }
  ]
}

The tool list changes with the page, so the server cannot hold a fixed copy. It forwards what it receives.

What the server must not do

The server does not run tools. It has no access to the page, the session, or the user interface. It adds the key, forwards the request, and returns the response. Tool handlers run in the browser, as the signed-in person, under the rules your application already applies.

The demo server

This repository ships a small Node server for development. It is not a product.

cp playground/.env.example playground/.env
pnpm playground:server

Variable	Purpose
ACTIONWIRE_UPSTREAM_URL	The provider chat-completions URL.
ACTIONWIRE_MODEL	The model name to request.
ACTIONWIRE_API_KEY	The provider key. Server side only.

Write your provider key into playground/.env before you start the server. The copied file leaves ACTIONWIRE_API_KEY empty. Without a key, every request returns 503 and the message Set ACTIONWIRE_UPSTREAM_URL, ACTIONWIRE_MODEL, and ACTIONWIRE_API_KEY.

It listens on 127.0.0.1:8787. Set ACTIONWIRE_PORT to use a different port. The Vite configurations proxy /api/assistant to that address.

pnpm playground:dev starts this endpoint for you, so you need pnpm playground:server only when you want the endpoint on its own. The key stays in the Node process. Vite never sends it to the browser.

WARNING

The demo server has no authentication and no rate limit. A production route needs both, plus a size limit on the request body and a check that the caller is a signed-in user of your application.

Using a different provider

Any endpoint that accepts the OpenAI chat-completions shape works. To use a provider with a different shape, write your own adapter instead. It is one method:

import type { AgentAdapter } from 'actionwire';

export const myModel: AgentAdapter = {
  async generate({ messages, tools, signal }) {
    // Call your provider, then return the text and any tool calls.
    return { text: 'Done.', toolCalls: [] };
  },
};

Read moreAgentAdapter reference