Title	Javascript documentation for API endpoints

URL Name	000006272

Audience	Public

Product (Internal List) aiWare - API

Body

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

AiwareJsClient.AdminAPI

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

AiwareJsClient.EngineAPI

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

AiwareJsClient.EngineAgentApi

requestEnginesToLaunch	POST /ai13s/engine_agent/request_engines	Request engines to launch in the cluster
updateEngineAgentStatus	POST /ai13s/engine_agent/update_status	Update information for engine nodes in the cluster
upsertK8sHosts	POST /ai13s/engine_agent/hosts	Adds or updates K8s nodes to AIWARE hosts

AiwareJsClient.FlowAPI

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

aiwareJsClient.HostAPI

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

AiwareJsClient.ProcessAPI

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

AiwareJsClient.ProxyAPI

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

SecurityAPI

getStorageServerPublicKeyset

POST /security/getstorageserverpublickeyset

Get public storage server keyset for verification

ServiceAPI

createServiceInstance	POST /service/instance/create	This creates a new service instance
deleteServiceInstance	POST /service/instance/{ServiceInstanceID}/delete	This deletes a service instance
getResourcesForServiceInstance	GET /service/instance/{ServiceInstanceID}/resources	Get resources for service instance

AiwareJsClient.StorageAPI

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

Created Date	11/21/2024 12:33 AM

Last Modified Date	11/21/2024 12:33 AM

Last Published Date	11/21/2024 12:33 AM

Article Record Type	Documentation

Veritone Record Type	Documentation

Article Number	000006272

Javascript documentation for API endpoints

On this page:

AiwareJsClient.AdminAPI

AiwareJsClient.EngineAPI

AiwareJsClient.EngineAgentApi

AiwareJsClient.FlowAPI

aiwareJsClient.HostAPI

AiwareJsClient.ProcessAPI

AiwareJsClient.ProxyAPI

SecurityAPI

ServiceAPI

AiwareJsClient.StorageAPI