Docs

Prelim docs

Prelim has two ways to read your hiring data from outside the dashboard: a REST API and an MCP server. Both are read-only, both accept the same auth, and both expose the same data.

Setting up Prelim via an AI agent?

Point it at https://prelim.chat/llms-full.txt for one-shot setup + reference. One URL, plain text, everything an agent needs to wire up either MCP or REST against your account.

Which one should I use?

Use the REST API if you are writing a script, a backend integration, a webhook handler, or anything else that talks HTTP directly. Authentication is a single header. Responses are JSON.

Use the MCP server if you want to ask questions about your hiring pipeline from Claude.ai, Claude Desktop, ChatGPT, or Cursor. The MCP server speaks the Model Context Protocol so the AI assistant can call the right tool on your behalf. No code required.

Same data, same auth

Both surfaces are read-only. Both honor the same organization scope. An API key minted in your dashboard works against the REST API directly, and an OAuth token issued via the MCP consent flow can hit either surface. There is one underlying API.

Status

Both surfaces are live and supported. The REST API is stable; we version breaking changes. The MCP server tracks the API.