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.

Outbound partners

Read as Markdown

Choose an action to read its inputs, results, and usage guidance. Your connection determines which tools are available to you.

Outbound partners are recipients you configure for future Deals. Their package controls the application and delivery setup.

Set up a recipient

Read outbound_channels.get to inspect the current setup. Use outbound_channels.create to create a custom recipient and draft package together. Creating the draft does not publish it, connect another Portal, or submit a Deal. Review its Deal Package before publishing.

Connected recipients and custom recipients with attributed Deals cannot be deleted through these tools. Deleting an unused custom recipient keeps its reusable package.

Control matchmaking independently of publication

Both outbound_channels.list and outbound_channels.get return the sender preference is_matchmaking_enabled, actual eligibility is_matchmaking_available, and matchmaking_unavailable_reason. Eligibility requires inclusion plus published usable setup; it does not guarantee a match for a specific business. The reason is disabled, unpublished, or setup_incomplete, and is null when eligible. Disabled takes precedence when more than one gate blocks participation.

The update pair requires the existing opt-in Outbound channels: administration MCP toolset. A toolset grant does not widen Portal permissions.

Use the existing outbound_channels.review_update with changes: { is_matchmaking_enabled: false }, then outbound_channels.update with its unchanged review token to disable recommendations. Use true to re-enable; omitted fields remain unchanged. Publication, existing Deals, and manual Deal creation stay available when setup is ready. Enabling an unpublished partner does not publish it or make it eligible.

Custom and connected partners support this sender-owned preference. Connected partners do not permit identity, contact, or package changes through this update. Sender Owners, Members, Support, and staff may change matchmaking; custom setup fields still require Owner, Support, or staff. Read editable_fields and revision from the detail before proposing changes. Updates return the updated channel summary; read the detail again for the current revision and capabilities.

Review changes before applying them

For recipient updates, sharing, and deletion, use the action's review_* tool, explain the effects, and obtain a second explicit confirmation before sending user_confirmed: true with the unchanged review token. Reviews expire after ten minutes or when the reviewed state changes. Confirmation does not grant additional Portal permissions.

Reuse client_request_id only for an identical retry.

Available tools

outbound_channels.listList Outbound partnersoutbound_channels.getGet Outbound partner detailsoutbound_channels.createCreate custom Outbound partneroutbound_channels.review_change_sharingReview outbound channel change sharingoutbound_channels.review_updateReview outbound channel updateoutbound_channels.change_sharingChange sharing outbound channeloutbound_channels.updateUpdate outbound channeloutbound_channels.review_deleteReview outbound channel deleteoutbound_channels.deleteDelete outbound channel