🚀 Run an Analysis on the NCA Engine
Once a file is uploaded you can run an NCA Engine Execution against it.
In general, you can follow the flow of:
- Uploading a file
- Then run an execute action right away
Or
- Upload one or more files
- Run executions at a later date and time. see Listing Files
Tip
No matter which flow you take, the execution portion is the same and in this section, we'll take a deeper dive into how to run an execution.
Route
The final routes are subject to change before Go-Live Summer 2024
The following applies to EARLY ACCESS prior to Go Live.
Some of our routes will be changing prior to our final go-live date this summer (2024). They won't change during Early Access, but be sure to check the documentation.
In order to make a smooth tranistion, we'll provide detailed information on which routes changed and which remained the same. As a good programming practice, you store the routes in a central library for easier migration.
Older routes may be kept active for short period of time to help with any transitions.
Payload
To run an analysis, you need to provide two required sections of the payload and an optional set of meta-data.
| Name | Description |
|---|---|
| The Analysis File | You'll need the S3 bucket and the Object Key which was returned to you during the presigning process. You can also get a list of files available to you through an API call. |
| The Configuration | supplied in JSON format |
| Meta Data | Optional: Supplied in JSON format or text. This is stored "as-is" in the record and you can use to as you see fit. Example uses: Tracking id's for internal use. Tagging Team members etc. |
Payload Example
Below is a sample of the payload required for submission. For this quick introduction to the payload we'll skip all the details and only show the 3 parts, including the optional "meta_data".
Full Payload Example
Below is a full sample of the payload. The meta_data is just an example and can be formatted with any valid JSON or a simple value for a text block.
As you can see the meta_data can be useful for storing additional data along with your analysis.
The configuration includes the necessary parameters that are required to run your analysis.
Tip
For now you don't need to know the details of the configuration file. We have fully functioning samples to help you get started.
Response
The response will come back with an execution_id and a status. Use execution_id to get status updates.
Example with 🐍 Python
Example of how an execution is launched.