Title	REST documentation for endpoints

URL Name	000006115

Audience	Public

Product (Internal List) aiWare - aiWare

Body

AdminAPI

Method	HTTP request
addEngineToResource This API adds the engine to the resource	POST /admin/resource/{ResourceID}/engine
addServiceToResource This API adds the service to the resource	POST /admin/resource/{ResourceID}/service
addserversServerType This API add servers to the specified server type	POST /admin/server_type/{ServerTypeID}/add
adminTerminateCluster This terminates the cluster	POST /admin/terminate
applyLicense This applies a license to aiWARE	POST /admin/licenses/apply
checkAuth This check auth for a token	POST /admin/auth
clearBacklog This clears some or all of the currently queued tasks	POST /admin/backlog/clear
createAdminApplication This creates a new application	POST /admin/applications/create
createAdminCore This creates a new core	POST /admin/cores/create
createAdminOrganization This updates the config for the cluster for a given key	POST /admin/organizations/create
createPermission This creates a new permission	POST /admin/users/permission/create
createResource This API creates a new resource definition such as a database, nsq or redis DB.	POST /admin/resource/create
createRole This creates a new role	POST /admin/users/role/create
createServerType This creates a new server type	POST /admin/server_types/create
createServerTypeEngineRunning This creates a new server_type_engine_running	POST /admin/server_types/running_engine/create
createService This API creates a new service definition.	POST /admin/service/create
createToken This creates a new token	POST /admin/tokens/create
createUser This creates a new user	POST /admin/users/create
deleteApplication This deletes an application	POST /admin/applications/{ApplicationID}/delete
deleteLicense This deletes a license from aiWARE	DELETE /admin/licenses/{LicenseID}/delete
deleteOrganization This deletes the specified organization	POST /admin/organization/{OrganizationID}/delete
deleteResource This deletes the specified resource	POST /admin/resource/{ResourceID}/delete
deleteRole This deletes a role	POST /admin/users/role/{RoleID}/delete
deleteServerType This API deletes the specified server type	DELETE /admin/server_type/{ServerTypeID}/delete
deleteServerTypePost This API deletes the specified server type	POST /admin/server_type/{ServerTypeID}/delete
deleteServerTypeRunningEngine This API deletes the running engine for a server type	DELETE /admin/server_type/{ServerTypeID}/engine/{EngineID}/delete
deleteService This API deletes a specific service	POST /admin/services/{ServiceID}/delete
deleteToken This deletes a token	POST /admin/token/{TokenID}/delete
deleteUser This deletes a user	POST /admin/user/{UserID}/delete
desiredserversServerType This API add servers to the specified server type	POST /admin/server_type/{ServerTypeID}/desired
getAdminApplicationDetail This provides information on the given application.	GET /admin/application/{ApplicationID}/detail
getAdminCoreDetail This provides information on the given core.	GET /admin/core/{CoreID}/detail
getAdminCores This provides a list of core systems	GET /admin/cores
getAdminEngineConfigSectionKey This provides a config section key for the engine	GET /admin/engine/{EngineID}/config/{ConfigSection}/{ConfigKey}
getAdminOrganizationDetail This gets organization detail by ID	GET /admin/organization/{OrganizationID}/detail
getAdminOrganizationTokens This provides information on the given organization tokens.	GET /admin/organization/{OrganizationID}/tokens
getAdminOrganizations This provides a list of organizations	GET /admin/organizations
getAdminPermissionDetail This gets permission detail by ID	GET /admin/users/permission/{PermissionID}/detail
getAdminRoleDetail This gets role detail by ID	GET /admin/users/role/{RoleID}/detail
getAdminServiceConfig This provides all the config for the service	GET /admin/service/{ServiceID}/config
getAdminServiceConfigSection This provides all the config for the service	GET /admin/service/{ServiceID}/config/{ConfigSection}
getAdminServiceConfigSectionKey This provides a config section key for the service	GET /admin/service/{ServiceID}/config/{ConfigSection}/{ConfigKey}
getAdminServiceInstances This lists the service instances available for a system	GET /admin/service/instances
getAdminServiceInstancesByServiceID This lists the service instances available by service ID	GET /admin/service/{ServiceID}/instances
getAdminStatus This provides information on the status of the aiWARE edge	GET /admin/status
getAdminTokenDetail Get the token info by ID	GET /admin/token/{TokenID}/detail
getAdminTokenPermissions This provides a list of all token permissions for a token by TokenID	GET /admin/token/{TokenID}/permissions
getAdminTokens This provides information about all tokens.	GET /admin/tokens
getAdminUserDetail This provides information on the given user.	GET /admin/user/{UserID}/detail
getAdminUserPermissions This provides a list of all user permissions for an user by UserID	GET /admin/user/{UserID}/permissions
getAdminUserTokens This provides information on the given user.	GET /admin/user/{UserID}/tokens
getAdminUsers This provides a list of users in the system	GET /admin/users
getAdminUsersPermission This provides a list of all user permissions in the system	GET /admin/users/permissions
getAdminUsersRoles This provides a list of user role in the system	GET /admin/users/roles
getApplications Get the list of applications deployed and available on aiWARE	GET /admin/applications
getBacklogSummary This provides summary information on the current backlog	GET /admin/backlog/summary
getConfig This provides all the config for the cluster	GET /admin/config
getConfigSection This provides all the config for the cluster	GET /admin/config/{ConfigSection}
getConfigSectionKey This provides a config section key for the cluster	GET /admin/config/{ConfigSection}/{ConfigKey}
getEnginesForResource Get list of engines for resource	GET /admin/resource/{ResourceID}/engines
getLicenseDetail This gets detail on a license key	GET /admin/licenses/{LicenseID}/detail
getLicenses This provides a licenses on the system	GET /admin/licenses
getMappingsForResource Get list of mappings for resource	GET /admin/resource/{ResourceID}/mappings
getResource Get a resource definition	GET /admin/resource/{ResourceID}
getResourceMappingDetail Get resource mapping detail	GET /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/detail
getResources Get the list of resources	GET /admin/resources
getResourcesForEngine Get list of resources for engine	GET /admin/engine/{EngineID}/resources
getResourcesForHost Get list of resources for host	GET /admin/host/{HostID}/resources
getResourcesForService Get list of resources for service	GET /admin/service/{ServiceID}/resources
getServerType This provides detail on the server type	GET /admin/server_type/{ServerTypeID}/detail
getServerTypeEngineRunning This lists the running engine with server types	GET /admin/server_types/running_engines
getServerTypeEngineRunningDetail This gets the detail of server type - running engine	GET /admin/server_type/{ServerTypeID}/engine/{EngineID}/detail
getServerTypes This lists the server types available on the system	GET /admin/server_types
getService This gets the service detail	GET /admin/service/{ServiceID}/detail
getServices This lists the services available on the system	GET /admin/services
loginUser This logs a user in if successful	POST /admin/users/login
oauthLoginUser This logs a user in if successful with OAuth2	POST /admin/users/oauth2_login
registerUser This registers a new user	POST /admin/users/register
removeEngineForResource This API removes the engine to the resource	POST /admin/resource/{ResourceID}/engine/{EngineID}/delete
removeserversServerType This API removes servers from the specified server type	POST /admin/server_type/{ServerTypeID}/remove
resetAllocTable This resets the alloc table	POST /admin/backlog/reset-alloc
signupInitialUser This registers a new initial user	POST /admin/users/signup/initial
updateAdminCore This updates a core system	POST /admin/core/{CoreID}/update
updateApplication This updates an application	POST /admin/applications/{ApplicationID}/update
updateConfigAll This gets the config for the cluster	POST /admin/config
updateConfigSection This gets the config for the cluster	POST /admin/config/{ConfigSection}
updateConfigSectionKey This updates the config for the cluster for a given key	POST /admin/config/{ConfigSection}/{ConfigKey}
updateEnginesForResource This API updates the specified server type-running engine	POST /admin/resource/{ResourceID}/engine/update
updateOrganization This updates a organization	POST /admin/organization/{OrganizationID}/update
updatePermission This updates a permission	POST /admin/users/permission/{PermissionID}/update
updateResource This API updates the specified resource	POST /admin/resource/{ResourceID}/update
updateResourceMapping This API updates the state of the specified resource mapping	POST /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/update
updateResourceMappingState This API updates the state of the specified resource mapping state	POST /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/updatestate
updateResourceState This API updates the state of the specified resource	POST /admin/resource/{ResourceID}/updatestate
updateRole This updates a role	POST /admin/users/role/{RoleID}/update
updateServerType This API updates the specified server type	POST /admin/server_type/{ServerTypeID}/update
updateServerTypeEngineRunning This API updates the specified server type-running engine	POST /admin/server_type/{ServerTypeID}/engine/{EngineID}/update
updateService This API updates a service.	POST /admin/service/{ServiceID}/update
updateToken This updates a token	POST /admin/token/{TokenID}/update
updateUser This updates a user	POST /admin/user/{UserID}/update
upsertServerTypes This API creates or updates the specified server types	POST /admin/server_type/upsert
userPasswordForgot This api will help users to reset their password when they forgot	POST /admin/users/password/forgot
userPasswordReset Helps users to reset their password	POST /admin/users/password/reset
userPasswordUpdate This api will help users to update their password	POST /admin/users/password/update

EngineAPI

Method	HTTP request
createBuild This API creates a new engine build	POST /admin/build/create
createEngine This API creates a new engine	POST /admin/engine/create
createEngineCategory This API creates a new engine category	POST /admin/engine/category/create
createJobForEngine This API create a job for the engine	POST /engine/{EngineID}/createjob
deleteBuildPost This API deletes a specific build	POST /admin/build/{BuildID}/delete
deleteEnginePost This API delets an engine	POST /admin/engine/{EngineID}/delete
deleteEngineTemplate Delete the template of the engine given its ID and template name	DELETE /engine/{EngineID}/template/{EngineTemplateName}
getEngineBuild This gets a particular build	GET /admin/build/{BuildID}/detail
getEngineBuilds Get the list of builds deployed and available on aiWARE for a particular engine	GET /admin/engine/{EngineID}/builds
getEngineBuildsByState The api returns engine build records by build state	GET /engine/builds
getEngineBuildsToDownload The api returns latest downloadable engine build records for each engine	GET /engine/builds/downloads
getEngineCategories This provides a list of engine categories	GET /admin/engine/categories
getEngineCategoryDetail This provides detail for an engine category	GET /admin/engine/category/{EngineCategoryID}/detail
getEngineContainerCount Get engine container count	GET /engine/container_count
getEngineDetail This API provides the engine detail result	GET /admin/engine/{EngineID}/detail
getEngineInstanceDetail Get information about an engine Instance	GET /engine/instance/{EngineInstanceID}/detail
getEngineInstanceList Get engines instances with filtering	GET /engine/instances
getEngineInstanceLogs Get engine instance logs as a zip file	GET /engine/instance/{EngineInstanceID}/logs
getEngineInstanceStatus Get the latest status of the engine instance	GET /engine/instance/{EngineInstanceID}/status
getEngineInstanceWork Get a work request	POST /engine/instance/{EngineInstanceID}/getwork
getEngineInstanceWorkDetail Get detail of the work being done by the engine instance	GET /engine/instance/{EngineInstanceID}/workdetail
getEngineInstances Get information about the instances of an engine	GET /engine/{EngineID}/instances
getEngineLaunchDetail This API returns the list of launches for this engine	GET /engine/{EngineID}/launch/{LaunchID}/detail
getEngineLaunches This API returns the list of launches for this engine	GET /engine/{EngineID}/launches
getEngineStats This gets useful engine statistics	GET /admin/engine/stats
getEngineTemplate Get the template of the engine given its ID and template name -- if EngineTeamplateName==`all`, all the templates for the engines will be returned	GET /engine/{EngineID}/template/{EngineTemplateName}
getEngines Get the list of engines deployed and available on aiWARE	GET /admin/engines
getJobsBacklogCountByEngine Get backlog count by engine	POST /proc/jobs/backlog_count_by_engine
getResourcesForEngineInstance Get resources for engine instance	GET /engine/instance/{EngineInstanceID}/resources
pauseBuild This API pauses a build so that tasks based on this engine build will not run.	POST /admin/build/{BuildID}/pause
pauseEngine This API pauses an engine so that tasks based on this engine will not run.	POST /admin/engine/{EngineID}/pause
registerEngineInstanceNoAuth Register a new engine instance without authorization	POST /engine/instance/register
replaceEngine This API replaced an engine so that tasks based on this engine will not run.	POST /admin/engine/{EngineID}/replace
resumeBuild This API resumes a build so that tasks based on this engine build will start running.	POST /admin/build/{BuildID}/resume
resumeEngine This API resumes a build so that tasks based on this engine build will start running.	POST /admin/engine/{EngineID}/resume
terminateEngineInstance Delete the engine instance record	POST /engine/instance/{EngineInstanceID}/terminate
updateEngine This API updates the specified engine	POST /admin/engine/{EngineID}/update
updateEngineBuild This API updates the specified engine	POST /admin/build/{BuildID}/update
updateEngineBuildState Update the Engine Build State	POST /engine/build/{BuildID}/state
updateEngineCategory This updates the specified engine category	POST /admin/engine/category/{EngineCategoryID}/update
updateEngineInstanceStatus Update the Engine Instance Status. Heartbeat to communicate back to controller both aggregated work and delta work from last heartbeat	POST /engine/instance/{EngineInstanceID}/updatestatus
upsertEngineTemplate Create or Update the template of the engine given its ID and template name	POST /engine/{EngineID}/template/{EngineTemplateName}

EngineAgentAPI

Method	HTTP request
requestEnginesToLaunch Request engines to launch in the cluster	POST /ai13s/engine_agent/request_engines
updateEngineAgentStatus Update information for engine nodes in the cluster	POST /ai13s/engine_agent/update_status

FlowAPI

Method	HTTP request
cleanAutomateRequests Clean old automate requests.	GET /flowaction/requests/clean
createNodeRedContainerInfo Create node-red container information	POST /flow/nrcontainer/create
deleteAutomateContainer Delete automate container.	POST /flow/delete/{ContainerID}
getAutomateContainers Get automate containers info.	GET /automate/containers
updateAutomateRequestStatus Put this automate request into update status mode. This automate request will be updated to new status.	POST /flow/request/update
updateAutomateStatus Get updated information to launch node-red container, terminate node-red container.	POST /flow/{HostID}/updatestatus

HostAPI

Method	HTTP request
drainHost Put this host into drain mode. A host in drain mode will not have work assigned to engines on the host.	POST /host/{HostID}/drain
getHostCpuUsage Get host cpu usage	GET /hosts/cpu_usage
getHostDetail Get the latest info of the host	GET /host/{HostID}/detail
getHostMemoryUsage Get host memory usage	GET /engine/memory_usage
getHostStatus Get the latest status of the host	GET /host/{HostID}/status
getHosts This provides a list of hosts in the system	GET /hosts
getHostsCounts Get the server counts in a time-range	GET /hosts/counts
getHostsCountsByType Get the server counts in a time-range	GET /hosts/counts_by_type
getHostsLaunch This provides a list of host launches in the system	GET /host/{HostID}/launch
hostAlert Notifies the controller about a system alert.	POST /host/alert
launchHost Launch a new host with a particular server type	POST /host/launch
pauseHost Pause all engines on this host.	POST /host/{HostID}/pause
registerEngineInstance Register a new engine instance	POST /host/{HostID}/engine/register
registerHost Update the Host Status	POST /host/register
resumeHost Resume all engines on this host.	POST /host/{HostID}/resume
terminateHost Delete the host/agent record. Any work still running on this host will be restarted on other hosts.	POST /host/{HostID}/terminate
updateHostStatus Update the Host Status

ProcessAPI

Method	HTTP request
addTask Adds a Task to a current job	POST /proc/job/{JobID}/addtask
addTaskRoute Adds a Task Route to a current job	POST /proc/job/{JobID}/addtaskroute
cancelJobs This cancels jobs	POST /proc/jobs/cancel
createJob This creates a new Job	POST /proc/job/create
deleteJob This API deletes the specified job	POST /proc/job/{JobID}/delete
deleteScheduledJob This deletes a scheduled job	POST /proc/scheduled_job/{ScheduledJobID}/delete
deleteTask This API deletes the specified task	POST /proc/task/{TaskID}/delete
getEngineErrorTimeRanges This gets engine error count by error tasks grouped by time ranges and sorted by a range start time	GET /proc/tasks/error/engine_error_time_ranges
getJobDetail Gets Job Detail	GET /proc/job/{JobID}/detail
getJobDownload Returns the contents of the job's output	GET /proc/job/{JobID}/download/{JobOutputName}
getJobOutput Returns the contents of the job's output	GET /proc/job/{JobID}/output/{JobOutputName}
getJobOutputs Returns a list of output information about this job	GET /proc/job/{JobID}/outputs
getJobPerformance This gets cpu/gpu, memory state of the hosts grouped by time ranges and sorted by a range start time	GET /proc/job/{JobID}/performance
getJobStatus Gets Job Status	GET /proc/job/{JobID}/status
getJobWorkRequests This provides a list of workrequests of a job	GET /proc/job/{JobID}/workrequests
getJobs This gets a list of jobs	GET /proc/jobs
getJobsOrganizationStats This gets processing stats of the jobs by organization	GET /proc/jobs/stats/organization
getJobsPerformance This gets cpu/gpu, memory state of the hosts grouped by time ranges and sorted by a range start time	GET /proc/jobs/performance
getJobsStats This gets processing stats of the jobs	GET /proc/jobs/stats
getJobsTimeRangesStats This gets processing stats of the jobs grouped by time ranges and sorted by a range start time	GET /proc/jobs/stats/time_ranges
getRatePendingScheduledJobs This gets the rate of pending scheduled jobs by time ranges	GET /proc/scheduled_jobs/rate_pending_time_ranges
getScheduledJobDetail This gets scheduled job detail	GET /proc/scheduled_job/{ScheduledJobID}/detail
getScheduledJobs This gets a list of scheduled jobs	GET /proc/scheduled_jobs
getServerErrorCounts Get server error counts in a time-range	GET /proc/tasks/error/server_error_counts
getTaskDetail Gets Task Detail	GET /proc/task/{TaskID}/detail
getTaskDownload Returns the contents of the task's output	GET /proc/task/{TaskID}/download/{TaskOutputName}
getTaskLogs Gets logs associated with a task	GET /proc/task/{TaskID}/logs
getTaskOutput Returns the contents of the task's output	GET /proc/task/{TaskID}/output/{TaskOutputName}
getTaskOutputs Gets Task Output	GET /proc/task/{TaskID}/outputs
getTaskReports Gets task reports	GET /proc/task/reports
getTaskReportsPerMonth Gets task reports for the month	GET /proc/task/reports/{ReportMonth}
getTaskSyncBacklog Gets task sync backlog in a time-range	GET /proc/tasks/sync_backlog
getTaskTimings Returns the timings associated with a task as collected by engine toolkit.	GET /proc/task/{TaskID}/timings
getTasks This gets a list of tasks based on the provided criteria	GET /proc/tasks
getTasksErrorTypeCountByEngine This gets error type count by engines	GET /proc/tasks/error/count_type_by_engine
getTasksErrors This provides a error list in a time range	GET /proc/tasks/errors
getTasksInstances This gets processing stats of the tasks	GET /proc/tasks/instances/by_category_host
getTasksStats This gets processing stats of the tasks	GET /proc/tasks/stats
getTasksStatsCategories This gets processing stats of the tasks grouped by engine categories	GET /proc/tasks/stats/categories
getTasksStatsEngines This gets processing stats of the tasks grouped by engine	GET /proc/tasks/stats/engines
getTasksStatsOrganizations This gets processing stats of the tasks grouped by engine, filter by organizations	GET /proc/tasks/stats/organizations
getTasksStatsTimeRanges This gets processing stats of the tasks grouped by time ranges and sorted by a range start time	GET /proc/tasks/stats/time_ranges
getTotalPendingScheduledJobs This gets the total pending scheduled jobs by time ranges	GET /proc/scheduled_jobs/total_pending_time_ranges
getWorkRequest This provides detail of workrequest	GET /proc/workrequest/{WorkRequestID}/detail
launchJobTemplate This launch a job based on the given job template	POST /proc/template/{TemplateID}/launch
listTaskReports Gets a list of task report links	GET /proc/task/listreports
pushContentToEndpoint Whatever is posted to this endpoint will be added to the child input folder(s) for the task_routes that have this endpoint. If more than one task_routes have this endpoint, it will be added to all child input folders.	POST /proc/endpoint/{Endpoint}
recheckJobStatus Force a recalculation of job status from tasks	GET /proc/job/{JobID}/recheck_status
tasksStatusExport Export a task status report as a excel file	GET /proc/tasks/stats/export
updateTaskStatus This updates the status for a bulk of tasks by taskID	POST /proc/tasks/update_status

ProxyAPI

Method	HTTP request
proxyGetWorkForEngineInstances Get work for engine instances running on the host	POST /proxy/{HostID}/getwork
proxyRegisterEngineInstances Register engine instances running on the host	POST /proxy/{HostID}/register
proxyTerminateEngineInstances Terminate engine instances running on this host.	POST /proxy/{HostID}/terminate
proxyUpdateEngineInstanceStatuses Update statuses of engine instances running on the host	POST /proxy/{HostID}/update

SecurityAPI

Method	HTTP request
getStorageServerPublicKeyset Get public storage server keyset for verification	POST /security/getstorageserverpublickeyset
createServiceInstance This creates a new service instance	POST /service/instance/create
deleteServiceInstance This deletes a service instance	POST /service/instance/{ServiceInstanceID}/delete
getResourcesForServiceInstance Get resources for service instance	GET /service/instance/{ServiceInstanceID}/resources

ServiceAPI

createServiceInstance

This creates a new service instance

POST /service/instance/create

deleteServiceInstance

This deletes a service instance

POST /service/instance/{ServiceInstanceID}/delete

getResourcesForServiceInstance

Get resources for service instance

GET /service/instance/{ServiceInstanceID}/resources

StorageAPI

Method	HTTP request
registerStorage Register Storage Instance	POST /storage/register
updateStorageInstanceStatus Update the Storage Instance Status	POST /storage/{StorageInstanceID}/updatestatus

Created Date	11/22/2024 9:35 PM

Last Modified Date	11/22/2024 9:39 PM

Last Published Date	11/22/2024 9:39 PM

Article Record Type	Documentation

Veritone Record Type	Documentation

Article Number	000006115

REST documentation for endpoints