HHS (US Department of Health and Human Services) Form Alpha API
The Form Alpha API from HHS (US Department of Health and Human Services) — 2 operation(s) for form alpha.
HHS (US Department of Health and Human Services) Form Alpha API is one of 21 APIs that HHS (US Department of Health and Human Services) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Form Alpha. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.
This API exposes 3 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version v0.
Requests are made against the base URL https://api.fda.gov.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
HHS (US Department of Health and Human Services) Form Alpha API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as X-SGG-Token (ApiJwtAuth).
An API key is passed in the header as X-SGG-Internal-Token (InternalApiJwtAuth).
An API key is passed in the header as X-API-Key (ApiUserKeyAuth).
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are FormAlphaSchema (17 properties), FormUpdateRequestSchema (14 properties), FormInstructionSchema (5 properties), ErrorResponseSchema (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HHS (US Department of Health and Human Services) 12
Other APIs HHS (US Department of Health and Human Services) publishes across the network.