This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Performs inference on the live deployment.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-execute.
objectmap<string, any>The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data.
objectThe response from transforming input data using a live deployment.
map<string, any>The output data from the model inference. The structure depends on the model's defined API specification, where each key is an output name and the value is the corresponding output data.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/transformJson?preview=true" \
-d '{"input":{"input_df":[{"feature_1":1.0,"feature_2":2}]}}'| Error Name | ||
|---|---|---|
Live | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The specified live deployment was not found. | |
| Parameters | liveDeploymentRid | |
Inference | Error Code | TIMEOUT |
| Status Code | 500 | |
| Description | The live deployment took longer than 5 minutes to respond to the inference request. This typically indicates the model execution is taking too long or the deployment is under heavy load. | |
| Parameters | liveDeploymentRid | |
Inference | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The inference request contains invalid input data that does not match the model's API specification. Check the error type for specific validation failure details. | |
| Parameters | liveDeploymentRid, errorType | |
Inference | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The inference request failed due to a model execution error or unexpected internal issue. This typically indicates a problem with the model itself rather than the input data. | |
| Parameters | liveDeploymentRid, errorMessage | |
Transform | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not transformJson the LiveDeployment. | |
| Parameters | liveDeploymentRid | |
See Errors for a general overview of errors in the platform.