Huma AI Engine API
The AI Engine API from Huma — 3 operation(s) for ai engine.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/huma-ai-engine-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Huma Platform AI Engine API
version: 1.0.0
description: Huma Platform
servers:
- url: https://workspace-gcp-uk.api.huma.com/api/integration/v1
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: AI Engine
paths:
/api/extensions/v1/generate/deployment:
post:
operationId: api_extensions_v1_generate_deployment_create_[generate_deployment]
summary: Generate Deployment
tags:
- AI Engine
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF'
multipart/form-data:
schema:
$ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF'
required: true
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateDeploymentResponseObjectDRF'
description: ''
/api/extensions/v1/hi-sidekick:
post:
operationId: api_extensions_v1_hi_sidekick_create_[chat_with_sidekick]
summary: Chat With Sidekick
tags:
- AI Engine
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HiSidekickRequestObjectDRF'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HiSidekickRequestObjectDRF'
multipart/form-data:
schema:
$ref: '#/components/schemas/HiSidekickRequestObjectDRF'
required: true
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HiSidekickResponseObjectDRF'
description: ''
/api/extensions/v1/user/{user_id}/generate/text:
get:
operationId: api_extensions_v1_user_generate_text_retrieve_[generate_text_head]
description: 'Generate Text Head
Check permissions CP while the feature is not available for public use'
summary: Generate Text Head
parameters:
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- AI Engine
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
description: No response body
post:
operationId: api_extensions_v1_user_generate_text_create_[generate_text]
summary: Generate Text
parameters:
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- AI Engine
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTextRequestObjectDRF'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GenerateTextRequestObjectDRF'
multipart/form-data:
schema:
$ref: '#/components/schemas/GenerateTextRequestObjectDRF'
required: true
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTextResponseObjectDRF'
description: ''
components:
schemas:
OffBoardingReasonsDRF:
type: object
properties:
reasons:
type: array
items:
$ref: '#/components/schemas/ReasonDRF'
otherReason:
type: boolean
UIWidgetDRF:
type: object
properties:
order:
type: integer
enabled:
type: boolean
config:
type: object
additionalProperties: {}
type:
type: string
id:
type: string
required:
- config
- order
- type
DeploymentStatsDRF:
type: object
properties:
completedCount:
$ref: '#/components/schemas/StatDRF'
completedTask:
$ref: '#/components/schemas/StatDRF'
consentedCount:
$ref: '#/components/schemas/StatDRF'
enrolledCount:
$ref: '#/components/schemas/StatDRF'
patientCount:
$ref: '#/components/schemas/StatDRF'
updateDateTime:
type: string
format: date-time
ModuleConfigDRF:
type: object
properties:
id:
type: string
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
moduleId:
type: string
moduleName:
type: string
shortModuleName:
type: string
status:
type: string
order:
type: integer
configBody:
type: object
additionalProperties: {}
about:
type: string
footnote:
$ref: '#/components/schemas/FootnoteDRF'
schedule:
$ref: '#/components/schemas/ModuleScheduleDRF'
ragThresholds:
type: array
items:
$ref: '#/components/schemas/RagThresholdDRF'
learnArticleIds:
type: array
items:
type: string
learnArticles:
type: array
items:
type: object
additionalProperties: {}
version:
type: integer
staticEvent:
$ref: '#/components/schemas/StaticEventDRF'
notificationData:
$ref: '#/components/schemas/NotificationDataDRF'
localizationPrefix:
type: string
goal:
$ref: '#/components/schemas/ModuleGoalDTODRF'
goalEnabled:
type: boolean
feedback:
$ref: '#/components/schemas/FeedbackConfigDRF'
feedbackTexts:
type: array
items:
$ref: '#/components/schemas/FeedbackTextsDRF'
readOnly:
type: boolean
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- moduleId
SurgeryDetailItemDRF:
type: object
properties:
key:
type: string
value:
type: string
order:
type: integer
required:
- key
- value
RecentFlagsDRF:
type: object
properties:
red:
type: integer
amber:
type: integer
green:
type: integer
gray:
type: integer
UserStatsDRF:
type: object
properties:
taskCompliance:
$ref: '#/components/schemas/TaskComplianceDRF'
studyProgress:
$ref: '#/components/schemas/StudyProgressDRF'
FeaturesDRF:
type: object
properties:
appMenu:
type: array
items:
type: string
appointment:
type: boolean
carePlanDailyAdherence:
type: boolean
offBoarding:
type: boolean
personalDocuments:
type: boolean
patientPersonalization:
$ref: '#/components/schemas/PatientPersonalizationDRF'
proxy:
type: boolean
surgeryDateRule:
$ref: '#/components/schemas/SurgeryDateRuleDRF'
labels:
type: boolean
portal:
type: object
additionalProperties: {}
offBoardingReasons:
$ref: '#/components/schemas/OffBoardingReasonsDRF'
moveUserReasons:
$ref: '#/components/schemas/MoveUserReasonsDRF'
messaging:
$ref: '#/components/schemas/MessagingDRF'
hideAppSupport:
type: boolean
summaryReport:
$ref: '#/components/schemas/SummaryReportDRF'
linkInvites:
type: boolean
classB:
type: boolean
deviceIntegration:
$ref: '#/components/schemas/DeviceIntegrationDRF'
customAppConfig:
type: object
additionalProperties: {}
improvedOnboarding:
type: boolean
timeline:
type: boolean
profilePicture:
type: boolean
unitsIsHidden:
type: boolean
dataDownloadIsHidden:
type: boolean
labelIsHidden:
type: boolean
ifuIsHidden:
type: boolean
videoAdapter:
type: string
mealBasedModules:
type: array
items:
type: string
email:
$ref: '#/components/schemas/EmailConfigDRF'
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
SsoDRF:
type: object
properties:
name:
type: string
org:
type: string
info:
$ref: '#/components/schemas/SsoInfoDRF'
SurgeryDetailsDRF:
type: object
properties:
operationType:
$ref: '#/components/schemas/SurgeryDetailDRF'
implantType:
$ref: '#/components/schemas/SurgeryDetailDRF'
roboticAssistance:
$ref: '#/components/schemas/SurgeryDetailDRF'
PAMIntegrationConfigDRF:
type: object
properties:
submitSurveyURI:
type: string
enrollUserURI:
type: string
clientExtID:
type: string
clientPassKeyEncrypted:
type: string
subgroupExtID:
type: string
required:
- clientExtID
- clientPassKeyEncrypted
- enrollUserURI
- subgroupExtID
- submitSurveyURI
UnseenFlagsDRF:
type: object
properties:
red:
type: integer
amber:
type: integer
green:
type: integer
gray:
type: integer
ManagerNotificationsDRF:
type: object
properties:
demographicsChange:
type: boolean
UITabDRF:
type: object
properties:
order:
type: integer
id:
type: string
screenId:
type: string
name:
type: string
type:
type: string
description:
type: string
icon:
type: string
status:
type: string
background:
$ref: '#/components/schemas/BackgroundDRF'
widgets:
type: array
items:
$ref: '#/components/schemas/UIWidgetDRF'
extras:
type: object
additionalProperties: {}
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
required:
- background
- icon
- name
- order
- status
DeploymentLevelConfigurationDRF:
type: object
properties:
targetConsentedMonthly:
type: integer
targetConsented:
type: integer
day0Anchor:
type: string
targetCompleted:
type: integer
DeviceIntegrationDRF:
type: object
properties:
enabled:
type: boolean
FileFieldDRF:
type: object
properties:
fileId:
type: string
required:
- fileId
UserLabelDRF:
type: object
properties:
labelId:
type: string
assignedBy:
type: string
assignDateTime:
type: string
format: date-time
HiSidekickResponseObjectDRF:
type: object
properties:
answer:
type: string
imageUrl:
type: string
article:
type: object
additionalProperties: {}
appConfig:
type: object
additionalProperties: {}
PeriodProgressDRF:
type: object
properties:
taskCompliance:
type: number
format: double
startDateTime:
type: string
format: date-time
openQueriesAmount:
type: integer
passedDueDateFormsAmount:
type: integer
passedDatesCounter:
type: array
items:
$ref: '#/components/schemas/PassedDueDateEventsAmountDRF'
LabelDRF:
type: object
properties:
id:
type: string
text:
type: string
authorId:
type: string
createDateTime:
type: string
format: date-time
updatedBy:
type: string
updateDateTime:
type: string
format: date-time
isStatic:
type: boolean
operations:
type: array
items:
type: string
BackgroundDRF:
type: object
properties:
value:
type: string
type:
type: string
required:
- type
- value
PassedDueDateEventsAmountDRF:
type: object
properties:
endDateTime:
type: string
format: date-time
amount:
type: integer
SdkConfigDRF:
type: object
properties:
sdkApiUrl:
type: string
accessKey:
type: string
secretKey:
type: string
teamId:
type: string
partnerId:
type: string
ThresholdRangeDRF:
type: object
properties:
minValue:
type: number
format: double
maxValue:
type: number
format: double
exactValueStr:
type: string
IntegrationDeviceDRF:
type: object
properties:
model:
type: string
modelName:
type: string
displayName:
type: string
manufacturer:
$ref: '#/components/schemas/DeviceManufacturerDRF'
moduleIds:
type: array
items:
type: string
backgroundSync:
type: boolean
supportedMedications:
type: object
additionalProperties: {}
required:
- manufacturer
- model
KeyActionConfigDRF:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
deltaFromTriggerTime:
type: string
durationFromTrigger:
type: string
durationIso:
type: string
instanceExpiresIn:
type: string
type:
type: string
trigger:
type: string
notifyEvery:
type: string
numberOfNotifications:
type: integer
learnArticleId:
type: string
learnArticle:
type: object
additionalProperties: {}
moduleId:
type: string
moduleConfigId:
type: string
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- deltaFromTriggerTime
- durationIso
- trigger
- type
BuilderDRF:
type: object
properties:
tabs:
type: array
items:
$ref: '#/components/schemas/UITabDRF'
SsoInfoDRF:
type: object
properties:
clientId:
type: string
clientSecret:
type: string
discoveryUrl:
type: string
redirectUri:
type: string
xmlsecBinary:
type: string
entityid:
type: string
service:
type: object
additionalProperties: {}
metadata:
type: object
additionalProperties: {}
keyFile:
type: string
certFile:
type: string
encryptionKeypairs:
type: array
items:
type: object
additionalProperties: {}
organization:
type: object
additionalProperties: {}
contactPerson:
type: object
additionalProperties: {}
certificateCrt:
type: string
samlMetadataXml:
type: string
privateKey:
type: string
required:
- clientId
- clientSecret
- discoveryUrl
- redirectUri
EmailTemplateDRF:
type: object
properties:
name:
type: string
subject:
type: string
template:
type: string
required:
- name
- template
PatientPersonalizationDRF:
type: object
properties:
rag:
type: boolean
goal:
type: boolean
DeviceManufacturerDRF:
type: object
properties:
name:
type: string
displayName:
type: string
sdkKey:
type: string
sdkConfig:
$ref: '#/components/schemas/SdkConfigDRF'
required:
- name
GenerateTextResponseObjectDRF:
type: object
properties:
prompt:
type: string
generatedText:
type: string
ConsentDRF:
type: object
properties:
id:
type: string
enabled:
type: string
review:
$ref: '#/components/schemas/ConsentReviewDRF'
revision:
type: integer
additionalConsentQuestions:
type: array
items:
$ref: '#/components/schemas/AdditionalConsentQuestionDRF'
signature:
$ref: '#/components/schemas/ConsentSignatureDRF'
sections:
type: array
items:
$ref: '#/components/schemas/ConsentSectionDRF'
instituteName:
type: string
instituteFullName:
type: string
instituteTextDetails:
type: string
admissionText:
type: string
createDateTime:
type: string
format: date-time
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- enabled
DeploymentInfoDRF:
type: object
properties:
id:
type: string
name:
type: string
code:
type: string
draftId:
type: string
status:
type: string
required:
- id
- name
AdditionalContactDetailsDRF:
type: object
properties:
altContactNumber:
type: string
regularContactName:
type: string
regularContactNumber:
type: string
emergencyContactName:
type: string
emergencyContactNumber:
type: string
TaskComplianceDRF:
type: object
properties:
current:
type: integer
total:
type: integer
due:
type: integer
updateDateTime:
type: string
format: date-time
percentage:
type: integer
MoveUserReasonsDRF:
type: object
properties:
reasons:
type: array
items:
$ref: '#/components/schemas/ReasonDRF'
otherReason:
type: boolean
AuthorisedRepDRF:
type: object
properties:
iconObject:
$ref: '#/components/schemas/S3ObjectDRF'
addressTitle:
type: string
address:
type: string
showBuildNumber:
type: boolean
required:
- address
- addressTitle
- iconObject
- showBuildNumber
StaticEventDRF:
type: object
properties:
enabled:
type: boolean
isoDuration:
type: string
title:
type: string
description:
type: string
required:
- description
- enabled
- title
SecurityDRF:
type: object
properties:
mfaRequired:
type: boolean
appLockRequired:
type: boolean
required:
- appLockRequired
- mfaRequired
FootnoteDRF:
type: object
properties:
enabled:
type: boolean
text:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
OnboardingModuleConfigDTODRF:
type: object
properties:
id:
type: string
onboardingId:
type: string
preloadNeeded:
type: boolean
status:
type: string
configBody:
type: object
additionalProperties: {}
order:
type: integer
version:
type: integer
versionString:
type: string
userTypes:
type: array
items:
type: string
organizationId:
type: string
reason:
type: string
deploymentIds:
type: array
items:
type: string
versionInt:
type: object
additionalProperties: {}
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
required:
- onboardingId
- order
FeedbackTextsDRF:
type: object
properties:
groupedBy:
type: array
items:
type: string
notifications:
type: array
items:
$ref: '#/components/schemas/FeedbackNotificationDataDRF'
GenderOptionTypeDRF:
type: object
properties:
displayName:
type: string
value:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- displayName
- value
GenerateDeploymentRequestObjectDRF:
type: object
properties:
inputText:
type: string
required:
- inputText
StudyProgressDRF:
type: object
properties:
currentPeriod:
type: integer
totalPeriods:
type: integer
totalCompliance:
type: number
format: double
periodProgress:
type: array
items:
$ref: '#/components/schemas/PeriodProgressDRF'
totalOpenQueriesAmount:
type: integer
S3ObjectDRF:
type: object
properties:
bucket:
type: string
key:
type: string
region:
type: string
required:
- bucket
- key
GenerateTextRequestObjectDRF:
type: object
properties:
user:
$ref: '#/components/schemas/UserDTODRF'
submitter:
$ref: '#/components/schemas/UserDTODRF'
deployment:
$ref: '#/components/schemas/DeploymentDTODRF'
action:
type: string
contexts:
type: array
items:
type: string
moduleIds:
type: array
items:
type: string
inputText:
type: string
required:
- action
SummaryReportDRF:
type: object
properties:
enabled:
type: boolean
UnreadMessagesCountDRF:
type: object
properties:
manager:
type: integer
user:
type: integer
ConsentSignatureDRF:
type: object
properties:
signatureTitle:
type: string
signatureDetails:
type: string
nameTitle:
type: string
nameDetails:
type: string
hasMiddleName:
type: boolean
showFirstLastName:
type: boolean
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- nameDetails
- nameTitle
- signatureDetails
- signatureTitle
AdditionalConsentQuestionDRF:
type: object
properties:
type:
type: string
enabled:
type: string
format:
type: string
text:
type: string
description:
type: string
order:
type: integer
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- enabled
- format
- text
- type
MessagingDRF:
type: object
properties:
enabled:
type: boolean
twoWayMessaging:
type: boolean
messages:
type: array
items:
type: string
allowCustomMessage:
type: boolean
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
ModuleGoalCreatedByDRF:
type: object
properties:
creatorId:
type: string
creatorName:
type: string
LocationDRF:
type: object
properties:
address:
type: string
country:
type: string
countryCode:
type: string
city:
type: string
latitude:
type: number
format: double
longitude:
type: number
format: double
postalCode:
type: string
state:
type: string
street:
type: string
ReasonDRF:
type: object
properties:
order:
type: integer
displayName:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- displayName
- order
EmailConfigDRF:
type: object
properties:
enabled:
type: boolean
templates:
type: array
items:
$ref: '#/components/schemas/EmailTemplateDRF'
RagThresholdDRF:
type: object
properties:
type:
type: string
severity:
type: integer
thresholdRange:
type: array
items:
$ref: '#/components/schemas/ThresholdRangeDRF'
color:
type: string
fieldName:
type: string
enabled:
type: boolean
mealGroup:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- color
- enabled
- fieldName
- severity
- thresholdRange
- type
SeverityFilterDRF:
type: object
properties:
severity:
type: integer
tags:
type: array
items:
type: string
required:
- severity
- tags
FeedbackTextDRF:
type: object
properties:
id:
type: string
text:
type: string
order:
type: integer
required:
- id
- text
ResearchTeamActionsDRF:
type: object
properties:
forms:
type: array
items:
type: string
ConsentReviewDRF:
type: object
properties:
title:
type: string
details:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- details
- title
SurgeryDetailDRF:
type: object
properties:
displayString:
type: string
placeHolder:
type: string
order:
type: integer
items:
type: array
items:
$ref: '#/components/schemas/SurgeryDetailItemDRF'
required:
- displayString
- placeHolder
DeploymentDTODRF:
type: object
properties:
termAndConditionUrl:
type: string
privacyPolicyUrl:
type: string
eulaUrl:
type: string
privacyPolicyObject:
$ref: '#/components/schemas/S3ObjectDRF'
termAndConditionObject:
$ref: '#/components/schemas/S3ObjectDRF'
eulaObject:
$ref: '#/components/schemas/S3ObjectDRF'
authorisedRep:
$ref: '#/components/schemas/AuthorisedRepDRF'
roles:
type: array
items:
$ref: '#/components/schemas/RoleDTODRF'
sso:
$ref: '#/components/schemas/SsoDRF'
id:
type: string
draftId:
type: string
name:
type: string
description:
type: string
status:
type: string
color:
type: string
icon:
$ref: '#/components/schemas/S3ObjectDRF'
iconFileId:
type: string
templateThumbnailFileId:
type: string
descriptionUrl:
type: string
isSaMD:
type: boolean
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
moduleConfigs:
type: array
items:
$ref: '#/components/schemas/ModuleConfigDRF'
onboardingConfigs:
type: array
items:
$ref: '#/components/schemas/OnboardingModuleConfigDTODRF'
learn:
$ref: '#/components/schemas/LearnDRF'
consent:
$ref: '#/components/schemas/ConsentDRF'
econsent:
$ref: '#/components/schemas/EConsentDRF'
keyActions:
type: array
items:
$ref: '#/components/schemas/KeyActionConfigDRF'
keyActionsEnabled:
type: boolean
profile:
$ref: '#/components/schemas/ProfileDRF'
features:
$ref: '#/components/schemas/FeaturesDRF'
extraCustomFields:
type: object
additionalProperties: {}
surgeryDetails:
$ref: '#/components/schemas/SurgeryDetailsDRF'
contactUsURL:
type: string
version:
type: integer
integration:
$ref: '#/components/schemas/IntegrationConfigDRF'
language:
type: string
duration:
type: string
security:
$ref: '#/components/schemas/SecurityDRF'
mfaRequired:
type: boolean
code:
type: string
enrollmentCounter:
type: integer
staticEventConfig:
$ref: '#/components/schemas/StaticEventConfigDRF'
stats:
$ref: '#/components/schemas/DeploymentStatsDRF'
localizations:
type: object
additionalProperties: {}
country:
type: string
dashboardConfiguration:
$ref: '#/components/schemas/DeploymentLevelConfigurationDRF'
labels:
type: array
items:
$ref: '#/components/schemas/LabelDRF'
tags:
type: array
items:
type: string
location:
$ref: '#/components/schemas/LocationDRF'
integrationDevices:
type: array
items:
$ref: '#/components/schemas/IntegrationDeviceDRF'
componentConfigs:
type: object
additionalProperties: {}
defaultUnits:
type: object
additionalProperties: {}
builder:
$ref: '#/components/schemas/BuilderDRF'
programId:
type: integer
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
ClinicianOnlyFieldsDRF:
type: object
properti
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-ai-engine-api-openapi.yml