Salesforce

Java API endpoint: requestEnginesToLaunch

« Go Back
Information
Java API endpoint: requestEnginesToLaunch
000008409
Public
Product Selection
aiWare - API
Article Details

EngineAgentAction requestEnginesToLaunch(engineLaunchRequest, xCorrelationId)

Request engines to launch in the cluster.

Example

// Import classes:
import com.veritone.aiware.ApiClient;
import com.veritone.aiware.ApiException;
import com.veritone.aiware.Configuration;
import com.veritone.aiware.auth.*;
import com.veritone.aiware.models.*;
import com.veritone.aiware.edge.EngineAgentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.aiware.com/edge/v1");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    EngineAgentApi apiInstance = new EngineAgentApi(defaultClient);
    EngineLaunchRequest engineLaunchRequest = new EngineLaunchRequest(); // EngineLaunchRequest | ai13s Engine Agent get engines to launch
    String xCorrelationId = "xCorrelationId_example"; // String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
    try {
      EngineAgentAction result = apiInstance.requestEnginesToLaunch(engineLaunchRequest, xCorrelationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineAgentApi#requestEnginesToLaunch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
engineLaunchRequestEngineLaunchRequestai13s Engine Agent get engines to launch
xCorrelationIdStringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional]

Return type

EngineAgentAction

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Valid status request* X-Correlation-Id -
400Invalid argument. Please see the error response for more information.* X-Aiware-Version -
* X-Correlation-Id -
401Not authorized* X-Aiware-Version -
* X-Correlation-Id -
403Forbidden* X-Aiware-Version -
* X-Correlation-Id -
404Not Found* X-Aiware-Version -
* X-Correlation-Id -
405The request is not allowed.* X-Aiware-Version -
* X-Correlation-Id -
429Too Many Requests* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -
501Not Implemented* X-Aiware-Version -
* X-Correlation-Id -
503System Unavailable* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -

 

Additional Technical Documentation Information
Properties
4/24/2025 5:25 PM
4/24/2025 5:25 PM
4/24/2025 5:25 PM
Documentation
Documentation
000008409
Translation Information
English

Powered by