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.

Deal packages

Read as Markdown

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

A Deal Package defines the application and delivery setup future Deals use for a recipient. Editing a package does not change answers in existing Deals.

Prepare and publish a package

  1. Choose an existing package or create a reusable draft with deal_packages.create. To create an Outbound partner and its package together, use outbound_channels.create.
  2. Read deal_packages.get_setup, then use deal_packages.update_setup with its revision and the fields you want to change in changes. You can change the application selection, confirmation message and existing delivery steps together. Omitted fields and steps are preserved; a supplied recipients list replaces that step’s recipients. Use the returned revision for your next edit. An identical retry returns the original saved setup; read setup again if later edits may have occurred.
  3. Review the draft before publishing. Draft delivery changes do not send email; publication applies the setup to future Deals.

To split a package, create and review replacement drafts before changing existing routes. Default packages and packages assigned to channels or Deals cannot be deleted.

Review changes before applying them

For publication, default selection, route reassignment, 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, including a completed deletion.

Available tools

deal_packages.listList deal packagedeal_packages.getGet deal packagedeal_packages.createCreate deal packagedeal_packages.get_config_schemaGet config schema deal packagedeal_packages.review_set_defaultReview deal package set defaultdeal_packages.get_configGet config deal packagedeal_packages.list_documentsList Deal Package source documentsdeal_packages.get_setupRead deal package application and email setupdeal_packages.get_document_textRead Deal Package source documentdeal_packages.replaceReplace deal packagedeal_packages.set_defaultSet default deal packagedeal_packages.update_setupUpdate package setupdeal_packages.validate_configValidate config deal packagedeal_packages.review_publishReview deal package publishdeal_packages.publishPublish deal packagedeal_packages.review_deleteReview deal package deletedeal_packages.deleteDelete deal package