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.

Download original submission

Read as Markdown

All MCP tools

deal_applications.get_submission_download

Download the original submission, including its saved signatures. Start with deal_applications.get_submission_package to check availability.

Choose what to download

  • artifact=zip: the application PDF, signature audit trail and supporting files.
  • artifact=pdf: the application and signature audit PDF.
  • artifact=file: one supporting document. Include its file_id from list_submission_files.

Retrieve the file

  • Public MCP: GET download.url with Authorization: Bearer <transfer_token> within five minutes. Use the returned token, not an API key. Transfer bytes outside the model and keep credentials private. Access is checked again when downloading.
  • Internal AI: use the returned staged_file with download_attachment. The limit is 25 MiB; choose individual files for larger packages.

After downloading, inspect the file before describing its contents. A file listing or successful download alone does not verify the statements or signatures inside it. This retrieves the saved copy; it does not regenerate it, retry preparation or submit the application again.

Operation
read
OAuth scopes
mcp

Availability depends on your assigned tools. Scopes do not grant record access. Read the tool description and current resource before changing it; follow the required revision and idempotency fields below.

Provider portal inputs

Name and descriptionRequired
application_idDeal Application id returned by deals.get or deals.create. Prefix: dapp_.Yes
artifactzip for the complete original; pdf for the application/audit PDF; file for a supporting document.Yes
file_idRequired only for artifact=file. Copy id from list_submission_files.No
provider_slugPortal workspace where the Deal Application is available. Copy provider_slug from providers.list; named slugs are valid.Yes
View exact input schema

Result

Check the structured result for success or an error before continuing.

View exact output schema

For this workflow’s steps and prerequisites, read the Deal applications guide.