Salesforce

Go API endpoint: EngineAPI

« Go Back
Information
Go API endpoint: EngineAPI
000004305
Public
Product Selection
aiWare - API
Article Details

All URIs are relative to https://api.aiware.com/edge/v1

MethodHTTP requestDescription
CreateBuildPost /admin/build/createThis API creates a new engine build
CreateEnginePost /admin/engine/createThis API creates a new engine
CreateEngineCategoryPost /admin/engine/category/createThis API creates a new engine category
CreateJobForEnginePost /engine/{EngineID}/createjobThis API create a job for the engine
DeleteBuildPostPost /admin/build/{BuildID}/deleteThis API deletes a specific build
DeleteEnginePostPost /admin/engine/{EngineID}/deleteThis API deletes an engine
DeleteEngineTemplateDelete /engine/{EngineID}/template/{EngineTemplateName}Delete the template of the engine given its ID and template name
GetEngineBuildGet /admin/build/{BuildID}/detailThis gets a particular build
GetEngineBuildsGet /admin/engine/{EngineID}/buildsGet the list of builds deployed and available on aiWARE for a particular engine
GetEngineBuildsByStateGet /engine/buildsThe api returns engine build records by build state
GetEngineBuildsToDownloadGet /engine/builds/downloadsThe api returns latest downloadable engine build records for each engine
GetEngineCategoriesGet /admin/engine/categoriesThis provides a list of engine categories
GetEngineCategoryDetailGet /admin/engine/category/{EngineCategoryID}/detailThis provides detail for an engine category
GetEngineContainerCountGet /engine/container_countGet engine container count
GetEngineDetailGet /admin/engine/{EngineID}/detailThis API provides the engine detail result
GetEngineInstanceDetailGet /engine/instance/{EngineInstanceID}/detailGet information about an engine Instance
GetEngineInstanceListGet /engine/instancesGet engines instances with filtering
GetEngineInstanceLogsGet /engine/instance/{EngineInstanceID}/logsGet engine instance logs as a zip file
GetEngineInstanceStatusGet /engine/instance/{EngineInstanceID}/statusGet the latest status of the engine instance
GetEngineInstanceWorkPost /engine/instance/{EngineInstanceID}/getworkGet a work request
GetEngineInstanceWorkDetailGet /engine/instance/{EngineInstanceID}/workdetailGet detail of the work being done by the engine instance
GetEngineInstancesGet /engine/{EngineID}/instancesGet information about the instances of an engine
GetEngineLaunchDetailGet /engine/{EngineID}/launch/{LaunchID}/detailThis API returns the list of launches for this engine
GetEngineLaunchesGet /engine/{EngineID}/launchesThis API returns the list of launches for this engine
GetEngineStatsGet /admin/engine/statsThis gets useful engine statistics
GetEngineTemplateGet /engine/{EngineID}/template/{EngineTemplateName}Get the template of the engine given its ID and template name -- if EngineTeamplateName==`all`, all the templates for the engines will be returned
GetEnginesGet /admin/enginesGet the list of engines deployed and available on aiWARE
GetJobsBacklogCountByEnginePost /proc/jobs/backlog_count_by_engineGet backlog count by engine
GetResourcesForEngineInstanceGet /engine/instance/{EngineInstanceID}/resourcesGet resources for engine instance
PauseBuildPost /admin/build/{BuildID}/pauseThis API pauses a build so that tasks based on this engine build will not run.
PauseEnginePost /admin/engine/{EngineID}/pauseThis API pauses an engine so that tasks based on this engine will not run.
RegisterEngineInstanceNoAuthPost /engine/instance/registerRegister a new engine instance without authorization
ReplaceEnginePost /admin/engine/{EngineID}/replaceThis API replaced an engine so that tasks based on this engine will not run.
ResumeBuildPost /admin/build/{BuildID}/resumeThis API resumes a build so that tasks based on this engine build will start running.
ResumeEnginePost /admin/engine/{EngineID}/resumeThis API resumes a build so that tasks based on this engine build will start running.
TerminateEngineInstancePost /engine/instance/{EngineInstanceID}/terminateDelete the engine instance record
UpdateEnginePost /admin/engine/{EngineID}/updateThis API updates the specified engine
UpdateEngineBuildPost /admin/build/{BuildID}/updateThis API updates the specified engine
UpdateEngineBuildStatePost /engine/build/{BuildID}/stateUpdate the Engine Build State
UpdateEngineCategoryPost /admin/engine/category/{EngineCategoryID}/updateThis updates the specified engine category
UpdateEngineInstanceStatusPost /engine/instance/{EngineInstanceID}/updatestatusUpdate the Engine Instance Status. Heartbeat to communicate back to controller both aggregated work and delta work from last heartbeat
UpsertEngineTemplatePost /engine/{EngineID}/template/{EngineTemplateName}Create or Update the template of the engine given its ID and template name
Additional Technical Documentation Information
Properties
1/29/2025 9:47 PM
1/29/2025 9:47 PM
11/21/2024 9:49 PM
Documentation
Documentation
000004305
Translation Information
English

Powered by