Skip to content
Levr API Documentation
Download OpenAPI specOpenAPI

Hand off to an AI agent

Copy instructions to your AI agent

Copy this guide into your AI agent. It links to the current REST API and MCP documentation.

You are helping someone integrate their system with Levr. Use Levr's published documentation and machine-readable contracts as the source of truth. Do not invent endpoints, fields, or MCP tools.

  1. Start with the Levr API documentation to choose between a server-to-server REST integration and a user-authorized MCP connection.
  2. For REST, read the Markdown REST API guide, choose the user’s task, then fetch only the relevant resource guide and operation Markdown. Resource indexes include task guidance. For funding recommendations, start with the Matchmaking guide. Use the OpenAPI specification for exact paths, authentication, parameters, and envelope schemas.
  3. For REST client intake, Deal applications, or project Criteria, fetch that resource's contract_url. Its Application Contract is the authority for the current questions, stable keys, repeatable groups, file-transfer steps, accepted answer shapes, conditional visibility, supported operation URLs, and integration instructions. Repeatable fields require the returned item_id. File bytes use the expiring upload_url and multipart field named file; they never belong in JSON. Do not substitute a static example or the latest application definition.
  4. For an AI client acting with a signed-in user's access, read the MCP connection instructions in Markdown first, then the Model Context Protocol guide if needed. Let the connected MCP server expose its current tools and input contracts; do not infer tools from the REST API. Read the relevant MCP resource guide and follow the discovered tool’s revision, file-transfer, and confirmation requirements.
  5. Use URLs from the record handoff when supplied; otherwise use this documentation environment. Keep API keys and file-transfer credentials out of browser code, logs, prompts, and source control.
  6. Before implementing a write, verify authentication, required inputs, idempotency, error responses, and retry guidance in the current contract. If an operation is not documented, do not assume it exists.

Early access

Request an integration

Tell us what your integration needs to do. Add an email if you want a reply.

Business guides

Choose your integration workflow

Read as Markdown

Choose the outcome your integration needs to produce, whether you are implementing for the receiving organisation or an external referrer. Each walkthrough explains the Lead source setup, the data to send, and how to check the result in the Portal.

Every flow starts with the same baseline: a business, its primary contact, and its relationship with the receiving Portal. A Lead source records where the business came from and chooses its initial setup. Pass its ID as source_channel_id to POST /v1/businesses/.

Starting experienceSetup added to the baselineWalkthrough
Business profile onlyNoneCreate a business profile
Client intakeAn empty client intake applicationCollect client intake
Deal applicationA Deal and empty application to the receiving PortalStart a deal application
Self-serve matchmakingPermission for the client to use matchmakingFind funding matches

These are starter setups, not permanent workflow restrictions. Starting with Business profile only, you can add intake, a Deal, or client matchmaking through later API calls. You can also create a project and run matching without enabling the client's matchmaking experience. The same business can use more than one of these workflows.

When you add forms later, the source still determines the published intake template and the application for Deals sent to the receiving Portal. Your key must have permission for each action and access to the relevant records. Each guide explains the Portal setup and application status required to continue. Changing a source's starting experience does not recreate applications or reconfigure existing businesses.

Before you implement

Ask the person who requested the integration which outcome they want and which Lead source to use. If the source already exists, read GET /v1/source-channels/{source_channel_id}/ to confirm its starting experience and readiness. For client intake and Deal applications, creation returns an application: read its contract before mapping answers. For matchmaking, create a Project for the funding request, then read that Project’s matching contract.

The receiving Portal is the workspace associated with the API key; it may belong to your organisation or the organisation receiving your referrals. You need an API key with the permissions and access scope required by that workflow. Get started explains authentication and API environments. Each guide identifies its additional permissions and source setup.

Understand what happens next

A Deal is a business’s funding application to one recipient. Creating a business and saving application answers are separate from submitting a completed application. Inviting the client is also a separate choice. Each guide shows where its workflow ends and what you or the client still need to do.

If you already have a Project and only need to work on its Criteria, use the Matchmaking guide.