Skip to main content
Developer

Launch locally

Open Settings → Larkup Server, switch the toggle to Agent, and select Launch server. Restart it after changing the Agent’s prompt, skills, or tools so the generated runtime picks up the new configuration.
Larkup Server settings with a running server and API key

Settings → Larkup Server showing the local endpoint and API key

Copy the endpoint and Server API key from this page. Every request must include the key in the Authorization header.

Customize the Agent

Open Settings → Agent Customization. It has five tabs that control what the Agent knows and can do.
Write the system prompt the Agent follows. Larkup combines it with its own retrieval and tool safety rules.
System prompt editor

Agent Customization: Prompt tab

Endpoints

Every generated server serves an interactive reference at GET /reference and a machine readable contract at GET /openapi.json.
Scalar API reference for the Larkup server

The interactive API reference for a running Larkup server

Connect

The full endpoint list is in the API Reference tab. To connect from the Vercel AI SDK, see Vercel AI SDK.

Authentication

/health, /readiness, /reference, and /openapi.json stay public for operations and discovery. Every other Knowledge and Agent request needs Authorization: Bearer <key>.

Deploy and connect remotely

Open Settings → Larkup Server → Server and select Deploy to choose a cloud provider. Larkup generates the runtime from the same Agent configuration used locally, including skills, MCP connections, and model settings. Use the same SDK client with the deployed URL. See Deploy Your Server for provider details.