How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Huma AI Engine API

The AI Engine API from Huma — 3 operation(s) for ai engine.

Huma AI Engine API is one of 77 APIs that Huma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AI Engine. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

This API exposes 4 operations across 3 paths, and defines 99 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://workspace-gcp-uk.api.huma.com/api/integration/v1.

4 operations 3 paths 99 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://workspace-gcp-uk.api.huma.com/api/integration/v1
Authentication
API Key, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Huma AI Engine API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (Hawk_Auth). It accepts HTTP bearer tokens (JWT) (JWT_Auth). It accepts HTTP bearer tokens (JWT) (jwtAuth).

  • Hawk_Auth — Hawk MAC authentication. Paste a full Authorization header value. Example: Authorization: Hawk id="userId:clientId", ts=" ", nonce=" ", mac=" "[, hash=" "][, e…
  • JWT_Auth — Use HTTP Bearer auth with a JWT. Send the token in the Authorization header: Authorization: Bearer The token should contain standard claims plus projectId and…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

AI Engine 4
POST
/api/extensions/v1/generate/deployment
Generate Deployment
api_extensions_v1_generate_deployment_create_[generate_deployment] body → 200
POST
/api/extensions/v1/hi-sidekick
Chat With Sidekick
api_extensions_v1_hi_sidekick_create_[chat_with_sidekick] body → 200
GET
/api/extensions/v1/user/{user_id}/generate/text
Generate Text Head
api_extensions_v1_user_generate_text_retrieve_[generate_text_head] 1 param → 200
POST
/api/extensions/v1/user/{user_id}/generate/text
Generate Text
api_extensions_v1_user_generate_text_create_[generate_text] 1 param body → 200

Schemas 99

The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are UserDTODRF (79 properties), DeploymentDTODRF (56 properties), ProfileFieldsDRF (31 properties), FeaturesDRF (30 properties). Each schema is shown below with its type and property counts.

OffBoardingReasonsDRF
object
2 properties
UIWidgetDRF
object
5 properties 3 required
DeploymentStatsDRF
object
6 properties
ModuleConfigDRF
object
25 properties 1 required
SurgeryDetailItemDRF
object
3 properties 2 required
RecentFlagsDRF
object
4 properties
UserStatsDRF
object
2 properties
FeaturesDRF
object
30 properties
SsoDRF
object
3 properties
SurgeryDetailsDRF
object
3 properties
PAMIntegrationConfigDRF
object
5 properties 5 required
UnseenFlagsDRF
object
4 properties
ManagerNotificationsDRF
object
1 property
UITabDRF
object
13 properties 5 required
DeploymentLevelConfigurationDRF
object
4 properties
DeviceIntegrationDRF
object
1 property
FileFieldDRF
object
1 property 1 required
UserLabelDRF
object
3 properties
HiSidekickResponseObjectDRF
object
4 properties
PeriodProgressDRF
object
5 properties
LabelDRF
object
8 properties
BackgroundDRF
object
2 properties 2 required
PassedDueDateEventsAmountDRF
object
2 properties
SdkConfigDRF
object
5 properties
ThresholdRangeDRF
object
3 properties
IntegrationDeviceDRF
object
7 properties 2 required
KeyActionConfigDRF
object
18 properties 4 required
BuilderDRF
object
1 property
SsoInfoDRF
object
16 properties 4 required
EmailTemplateDRF
object
3 properties 2 required
PatientPersonalizationDRF
object
2 properties
DeviceManufacturerDRF
object
4 properties 1 required
GenerateTextResponseObjectDRF
object
2 properties
ConsentDRF
object
13 properties 1 required
DeploymentInfoDRF
object
5 properties 2 required
AdditionalContactDetailsDRF
object
5 properties
TaskComplianceDRF
object
5 properties
MoveUserReasonsDRF
object
2 properties
AuthorisedRepDRF
object
4 properties 4 required
StaticEventDRF
object
4 properties 3 required
SecurityDRF
object
2 properties 2 required
FootnoteDRF
object
3 properties
OnboardingModuleConfigDTODRF
object
15 properties 2 required
FeedbackTextsDRF
object
2 properties
GenderOptionTypeDRF
object
3 properties 2 required
GenerateDeploymentRequestObjectDRF
object
1 property 1 required
StudyProgressDRF
object
5 properties
S3ObjectDRF
object
3 properties 2 required
GenerateTextRequestObjectDRF
object
7 properties 1 required
SummaryReportDRF
object
1 property
UnreadMessagesCountDRF
object
2 properties
ConsentSignatureDRF
object
7 properties 4 required
AdditionalConsentQuestionDRF
object
7 properties 4 required
MessagingDRF
object
5 properties
ModuleGoalCreatedByDRF
object
2 properties
LocationDRF
object
9 properties
ReasonDRF
object
3 properties 2 required
EmailConfigDRF
object
2 properties
RagThresholdDRF
object
8 properties 6 required
SeverityFilterDRF
object
2 properties 2 required
FeedbackTextDRF
object
3 properties 2 required
ResearchTeamActionsDRF
object
1 property
ConsentReviewDRF
object
3 properties 2 required
SurgeryDetailDRF
object
4 properties 2 required
DeploymentDTODRF
object
56 properties
ClinicianOnlyFieldsDRF
object
1 property
ProfileFieldsDRF
object
31 properties
IntegrationConfigDRF
object
1 property
ProfileExtraIdsDRF
object
8 properties
AdditionalContactDetailsItemDRF
object
6 properties
StaticEventConfigDRF
object
3 properties 2 required
StatDRF
object
2 properties 1 required
ModuleScheduleDRF
object
6 properties
LearnSectionDRF
object
7 properties
BoardingStatusDRF
object
5 properties 1 required
EConsentSectionDRF
object
11 properties 2 required
LearnDRF
object
5 properties
ProfileDRF
object
3 properties
FeedbackConfigDRF
object
9 properties 1 required
FeedBacksGroupedByRagDRF
object
2 properties 2 required
GenerateDeploymentResponseObjectDRF
object
8 properties
ConsentSectionOptionsDRF
object
5 properties 2 required
ConsentSectionDRF
object
6 properties 1 required
HiSidekickRequestObjectDRF
object
2 properties 1 required
PersonalDocumentDRF
object
6 properties 3 required
FeedbackNotificationDataDRF
object
5 properties
RoleDTODRF
object
5 properties
SurgeryDateRuleDRF
object
2 properties
EConsentDRF
object
16 properties 5 required
NotificationDataDRF
object
4 properties
RoleAssignmentDTODRF
object
4 properties 2 required
UserSurgeryDetailsDRF
object
3 properties
LearnArticleDRF
object
9 properties 2 required
EthnicityOptionDRF
object
3 properties 2 required
VariabilityFilterDRF
object
4 properties
LearnArticleContentDRF
object
12 properties 1 required
ModuleGoalDTODRF
object
9 properties
UserDTODRF
object
79 properties
AddressObjectDRF
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huma-ai-engine-api-openapi.yml Raw ↑

Other APIs Huma publishes across the network.

Huma Mobile & Web SDK
Huma Appointment API
Huma Assets API
Huma Audit Log API
Huma Auth API
Huma Authorization Admin API
Huma Autocomplete API
Huma Billing API
Huma Billing Portal Route API
Huma Builder API
Huma Calendar Route API
Huma CMS API
Where this information came from

This is an independent, third-party profile of Huma AI Engine API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.