Huma

Huma Deployment API

The Deployment API from Huma — 52 operation(s) for deployment.

GitHub OpenAPI

Operations 66

POST /api/extensions/v1/deployment Create Deployment #
GET /api/extensions/v1/deployment/{deployment_id} Retrieve Deployment #
PUT /api/extensions/v1/deployment/{deployment_id} Update Deployment #
POST /api/extensions/v1/deployment/{deployment_id}/component-config Create Component Config #
PUT /api/extensions/v1/deployment/{deployment_id}/component-config Update Component Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/component-config/{component_name} Delete Component Config #
GET /api/extensions/v1/deployment/{deployment_id}/devices List Deployment Devices #
POST /api/extensions/v1/deployment/{deployment_id}/devices Update Deployment Devices #
GET /api/extensions/v1/deployment/{deployment_id}/econsent Retrieve Latest Econsent #
POST /api/extensions/v1/deployment/{deployment_id}/econsent Create Econsent #
POST /api/extensions/v1/deployment/{deployment_id}/encrypt Encrypt Value #
POST /api/extensions/v1/deployment/{deployment_id}/export/localizations Export Deployment Localizations #
POST /api/extensions/v1/deployment/{deployment_id}/generate-master-translation Generate Master Translation #
POST /api/extensions/v1/deployment/{deployment_id}/import/localizations Import Deployment Localizations #
POST /api/extensions/v1/deployment/{deployment_id}/key-action Create Key Action Config #
PUT /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id} Update Key Action Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id} Delete Key Action Config #
POST /api/extensions/v1/deployment/{deployment_id}/key-actions Retrieve Deployment Key Actions #
GET /api/extensions/v1/deployment/{deployment_id}/labels Retrieve Deployment Labels #
POST /api/extensions/v1/deployment/{deployment_id}/labels Create Deployment Labels #
PUT /api/extensions/v1/deployment/{deployment_id}/labels/{label_id} Update Deployment Labels #
DELETE /api/extensions/v1/deployment/{deployment_id}/labels/{label_id} Delete Deployment Label #
POST /api/extensions/v1/deployment/{deployment_id}/learn-section Create Learn Section #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id} Update Learn Section #
DELETE /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id} Delete Learn Section #
POST /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article Create Article #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id} Update Article #
DELETE /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id} Delete Article #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/reorder Reorder Learn Articles #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/reorder Reorder Learn Sections #
GET /api/extensions/v1/deployment/{deployment_id}/localizable-fields Retrieve Localizable Fields #
POST /api/extensions/v1/deployment/{deployment_id}/module-config Create Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/module-config Update Module Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/module-config/{module_config_id} Delete Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/module-config/reorder Reorder Module Configs #
POST /api/extensions/v1/deployment/{deployment_id}/module-configs Create Module Configs #
POST /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config Create Onboarding Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config Update Onboarding Module Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/{onboarding_id} Delete Onboarding Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/reorder Reorder Onboarding Module Configs #
PUT /api/extensions/v1/deployment/{deployment_id}/role Create Or Update Roles #
POST /api/extensions/v1/deployment/{deployment_id}/update-localizations Create Localization #
GET /api/extensions/v1/deployment/{deployment_id}/version/{version_number} Retrieve Deployment By Version Number #
POST /api/extensions/v1/deployment/file-library Add Files To Library #
GET /api/extensions/v1/deployment/file-library/{library_id} Retrieve File Libraries #
POST /api/extensions/v1/deployment/full Create Full Deployment #
GET /api/extensions/v1/deployment/learn-section/cms/{article_id} Get Cms Article #
GET /api/extensions/v1/deployment/learn-section/cms/search Search Cms Articles #
GET /api/extensions/v1/deployment/modules Retrieve Modules #
POST /api/extensions/v1/deployment/move Move Deployments #
POST /api/extensions/v1/deployment/search Retrieve Deployments #
POST /api/extensions/v1/deployment/template Create Deployment Template #
GET /api/extensions/v1/deployment/template/{template_id} Retrieve Deployment Template #
PUT /api/extensions/v1/deployment/template/{template_id} Update Deployment Template #
DELETE /api/extensions/v1/deployment/template/{template_id} Delete Deployment Template #
GET /api/extensions/v1/deployment/templates Retrieve Deployment Templates #
POST /api/extensions/v1/deployment/user/email/send Send Email To Patients #
POST /api/extensions/v1/deployment/user/message/send Send Message To Patient List #
POST /api/extensions/v1/deployment/validate-questionnaire-dimensions Validate Questionnaire Dimensions #
POST /api/sdk/v1/deployment/{deployment_id}/draft Create Draft #
POST /api/sdk/v1/deployment/{deployment_id}/publish Publish Draft #
GET /api/sdk/v1/deployment/{deployment_id}/releases Retrieve Releases #
POST /api/sdk/v1/deployment/{deployment_id}/rollback Rollback Draft #
GET /api/sdk/v1/deployment/{deployment_id}/versions Retrieve Versions #

Documentation

📖
APIReference
https://workspace-gcp-uk.api.huma.com/docs
📖
Documentation
https://docs.huma.com/api-integration/intro
📖
GettingStarted
https://docs.huma.com/quick-start/backend/
📖
Authentication
https://docs.huma.com/quick-start/backend/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-deployment-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/errors/huma-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/data-model/huma-data-model.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/huma-deployment-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

huma-deployment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Huma Platform Deployment 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:


# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-deployment-api-openapi.yml