Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hedra Public API

Public endpoints are available to API users.

Hedra Public API is published by Hedra on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Public. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a quickstart.

This API exposes 9 operations across 7 paths, and defines 64 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, /web-app.

9 operations 7 paths 64 schemas 6 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.hedra.com/web-app
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hedra Public API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 9

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

Public 9

Public endpoints are available to API users.

GET
/public/models
List Models
list_models_public_models_get 1 param → 200422
GET
/public/voices
List Voices
list_voices_public_voices_get → 200
GET
/public/assets
List Assets
list_assets_public_assets_get 2 params → 200422
POST
/public/assets
Create Asset
create_asset_public_assets_post body → 200422
POST
/public/assets/{id}/upload
Upload Asset
upload_asset_public_assets__id__upload_post 1 param body → 200422
GET
/public/generations
List
list__public_generations_get 7 params → 200422
POST
/public/generations
Generate Asset
generate_asset_public_generations_post body → 200422
GET
/public/generations/{generation_id}/status
Get Status
get_status_public_generations__generation_id__status_get 1 param → 200422
GET
/public/billing/credits
Get Credits
get_credits_public_billing_credits_get → 200

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are GenerateVideoResponse (31 properties), AIModel (28 properties), GenerateImageResponse (25 properties), GenerateVideoRequest (23 properties). Each schema is shown below with its type and property counts.

GenerateVideoToVideoRequest
object
Video-to-video edit request for Kling O1 Edit model. Transforms videos using natural language while preserving motion.
14 properties 2 required
NormalizedPoint
array
GenerateSpeechToSpeechRequest
object
11 properties 2 required
GeneratedImage
object
5 properties 4 required
GenerateTextToSoundResponse
object
20 properties 6 required
BatchImageResultItem
object
Individual result item in a batch image generation.
6 properties 3 required
ValidationError
object
5 properties 3 required
GenerateVideoRequest
object
23 properties 1 required
GeneratedImageInputs
object
7 properties 1 required
GeneratedAudioInputs
object
8 properties 1 required
AIModel
object
28 properties 5 required
GenerateVideoUpscaleResponse
object
18 properties 6 required
GenerateIsolatedAudioRequest
object
10 properties 1 required
GenerateTextToSpeechRequest
object
15 properties 2 required
WorkspaceCreditUsage
object
Per-workspace credit usage for the current period, from the workspace credit pool. All three fields are display credits and stay continuous across the USD cuto…
6 properties 3 required
Body_upload_asset_public_assets__id__upload_post
object
1 property 1 required
Asset
object
10 properties 5 required
Uploaded3D
object
3 properties 2 required
HTTPValidationError
object
1 property
GenerateSpeechToSpeechResponse
object
17 properties 7 required
GenerateVideoToVideoResponse
object
20 properties 7 required
GenerateImageResponse
object
25 properties 6 required
SupportedLanguage
string
VoiceLabel
object
2 properties 2 required
PagedResponse_Generation_
object
2 properties 2 required
GenerationStatusResponse
object
12 properties 6 required
InputSlot
object
A typed input slot describing one kind of input a model accepts. Each slot has a media type (image, video, audio) and a role that distinguishes it from other s…
10 properties 2 required
GenerationError
object
2 properties 2 required
Voice
object
5 properties
GenerationType
string
Generation type enum NOTE: this enum is used to determine the type of generation and is used to determine the type of asset that will be generated.
GenerateImageUpscaleResponse
object
18 properties 6 required
GeneratedVideo
object
17 properties 7 required
VideoShot
object
A single shot in a multi-shot video generation.
2 properties 2 required
GenerateTextToSoundRequest
object
14 properties 1 required
CreateAssetResponse
object
6 properties 3 required
PageInfo
object
2 properties 2 required
GenerateIsolatedAudioResponse
object
16 properties 6 required
GenerationStatus
string
GenerateImageUpscaleRequest
object
12 properties 1 required
ErrorCode
string
Universal error code space. Modeled after gRPC status codes. Every exception in the system carries an ErrorCode. SDK clients map 3rd-party errors to these code…
KlingEditElement
object
Element for character/subject consistency in Kling video generation. Reference as @Element1, @Element2, etc. in prompt.
2 properties 1 required
InputMode
object
A named input mode grouping mutually exclusive input slots. Each mode represents a distinct way to use the model (e.g., imagetovideo vs firstlastframetovideo).…
2 properties 2 required
BatchVideoResultItem
object
Individual result item in a batch video generation.
7 properties 3 required
Generation
object
14 properties 6 required
GenerateMotionControlRequest
object
Motion Control request for transferring motion from a reference video to a character image. Processed through V2V infrastructure internally.
12 properties 3 required
GenerateImageRequest
object
17 properties 1 required
UploadedVideo
object
8 properties 4 required
Pricing
object
Extensible pricing information for AI models. Price is calculated as: credits = ceil((basecost + creditspersecond durationseconds) product(modifiers)) For vide…
3 properties
Dimension
object
2 properties 2 required
PagingParams
object
2 properties
GenerateVoiceCloneResponse
object
15 properties 7 required
UploadedAudio
object
4 properties 2 required
AssetType
string
UploadedImage
object
4 properties 3 required
AIModelPrice
object
3 properties 3 required
GenerateTextToSpeechResponse
object
21 properties 7 required
GenerateVideoUpscaleRequest
object
12 properties 1 required
GenerateMotionControlResponse
object
Response for Motion Control generations.
18 properties 8 required
GeneratedAudio
object
5 properties 3 required
CreateAssetRequest
object
4 properties 2 required
GenerateVoiceCloneRequest
object
9 properties 2 required
GenerateVideoResponse
object
31 properties 6 required
CreditBalance
object
Information about the current balance of Credits and usage.
5 properties 3 required
GeneratedVideoInputs
object
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hedra-public-api-openapi.yml Raw ↑