Skip to main content
Use this when a system of yours, such as a web shop or a backend service, should run a blueprint and use its result.

Before you start

  • The application is deployed and has an evaluation key (Deploy a release and call it, Create and revoke an evaluation key).
  • You can sign in to the Admin UI of the runtime cluster. Its address is the cluster address followed by /runtime-management/ui/, for example https://cluster.example.com/runtime-management/ui/.
  • A terminal with curl. The examples use the Pizza Pricing Calculator project.

Steps

1

Copy the run address

Open the Admin UI and click Sign in with Leapter. Choose the environment in the environment list at the bottom of the sidebar, and click the application’s name on the Status page. In the card Connect to with the application’s name, find the blueprint under Blueprints and click Copy next to Run address.
The card Connect to pizza-pricing-calculator-180269 with the MCP endpoints, the OpenAPI specification and, under Blueprints, the run address of Pizza Pricing. The Copy button of the run address has a green ring.

The run address of the blueprint Pizza Pricing.

A run address always has this form. The blueprint’s name is in lowercase with underscores:
In place of the name, the address also takes the blueprint’s ID. The name changes when the blueprint’s title changes; the ID does not.
2

Store the address and the key

Replace <run-address> with the run address you copied, and <your-evaluation-key> with your key:
3

Send the input

Send the blueprint’s inputs as a JSON object in a POST request. Send the key in the X-API-Key header. You can add an X-Correlation-Id header with an ID from your own system, for example an order number. It is stored with the run, and you can search for it later.
You should see 200 OK, an X-Run-Id header and the blueprint’s outputs in outputData:
Keep the X-Run-Id or your correlation ID if you want to find this run again.
4

Find the run

In the Admin UI, click Runs and type your correlation ID, here order-1042, in the search field. The run is listed with its status, release and duration. If your system sent the same correlation ID more than once, every run with it is listed, the newest first. Find a run and read usage explains the page, and how to open a run by its X-Run-Id.
5

Read the OpenAPI document

Every deployed release describes its blueprints in an OpenAPI document. Its address is in the card Connect to, next to Specification. Send the key here too:
The answer is an OpenAPI 3.0 document with one path per callable blueprint and the schema of its inputs and outputs. It starts like this:
The paths in the document use the blueprint’s ID (/models/f1ae47d5-…/runs), which works like the name. Tools that read OpenAPI can build a client from it.

Result

Your system runs the blueprint with a POST to its run address and reads the result from outputData. Each run has an ID in X-Run-Id, and the Admin UI shows the run under this ID.

Troubleshooting

After Sign in with Leapter, you are in the Lab and not in the Admin UI. Open the Admin UI’s address again and click Sign in with Leapter once more. The Status page opens. 400 Bad Request with "title":"Validation Error". An input is missing or has the wrong type. errors names each field:
Fields that the blueprint does not know are ignored. 401 Unauthorized. The key is missing, wrong, revoked, or belongs to another application or environment. The answer is the same in every case:
404 page not found as plain text. The environment or application in the address is wrong, or the application has no key yet. A new application’s first key needs about a minute. 404 Not Found with "title":"Model Not Found". The blueprint name in the address is wrong, or the blueprint is not public in this release:

What to do next