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.

Change application status

Read as Markdown · All MCP tools

deal_applications.change_status

Record one shared application lifecycle change using deal_applications.review_status_change first. Use the same application, target status and optional destination stage as reviewed. Choose optional communication recipients explicitly; review suggestions are not consent. Automatic effects still apply with recipients=[]. This operation owns status, stage synchronization, history and communications together. It does not deliver or submit an application. Retry identical arguments with the same idempotency key. Delivery is not verified by the receipt. Read deals.get afterwards to verify.

Operation
write
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.

Inputs

Name and descriptionRequired
allow_missing_funded_amountOnly when marking funded: explicitly allow an unknown funded amount. Other missing or invalid financing still blocks funding. Use the same value when reviewing and executing the change.No
application_idDeal Application ID (dapp_) from deals.get; not deal_id.Yes
destination_stage_idChoose a stage in this Deal's pipeline matching the target status. Omit to use your Portal's matching outcome stage, creating the default if needed. Other Portals follow their synchronization preferences.No
idempotency_keySee the input schema for constraints.Yes
messageSee the input schema for constraints.No
provider_slugProvider slug returned by providers.list; reuse a known value. Named slugs are valid.Yes
recipientsCopy each selected email AND origin from the review’s recipients. [] selects none; automatic effects still apply.Yes
review_tokenSee the input schema for constraints.Yes
target_statusis_pre_submitted: Not submitted; unavailable after a real submission; is_submitted_to_processor: Record submitted status only; does not deliver an application; is_declined: Declined; is_withdrawn: Withdrawn; is_timed_out: Timed out; is_disbursed: Funded; may create commission obligationsYes
user_confirmedSee the input schema for constraints.Yes
View exact input schema

Result

Check the structured result for success or an error before continuing. Read the affected record to confirm your change.

View exact output schema

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