List - Hedra API

List

curl --request GET \
  --url https://api.hedra.com/web-app/public/generations \
  --header 'X-API-Key: <api-key>'

{
  "page_info": {
    "limit": 123,
    "offset": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "image",
      "input": {
        "generated_video_inputs": {
          "text_prompt": "<string>",
          "resolution": "<string>",
          "aspect_ratio": "<string>",
          "duration_ms": 0,
          "bounding_box_target": [
            "<unknown>"
          ]
        },
        "type": "video",
        "ai_model_id": "d1dd37a3-e39a-4854-a298-6510289f9cf2",
        "start_keyframe_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "status": "complete",
      "progress": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "asset": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "image",
        "name": "<string>",
        "thumbnail_url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "asset": {
          "width": 123,
          "height": 123,
          "url": "<string>",
          "type": "uploaded_image"
        },
        "description": "<string>",
        "is_favorite": false
      },
      "error_message": "<string>"
    }
  ]
}

GET

generations

List

curl --request GET \
  --url https://api.hedra.com/web-app/public/generations \
  --header 'X-API-Key: <api-key>'

{
  "page_info": {
    "limit": 123,
    "offset": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "image",
      "input": {
        "generated_video_inputs": {
          "text_prompt": "<string>",
          "resolution": "<string>",
          "aspect_ratio": "<string>",
          "duration_ms": 0,
          "bounding_box_target": [
            "<unknown>"
          ]
        },
        "type": "video",
        "ai_model_id": "d1dd37a3-e39a-4854-a298-6510289f9cf2",
        "start_keyframe_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "status": "complete",
      "progress": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "asset": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "image",
        "name": "<string>",
        "thumbnail_url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "asset": {
          "width": 123,
          "height": 123,
          "url": "<string>",
          "type": "uploaded_image"
        },
        "description": "<string>",
        "is_favorite": false
      },
      "error_message": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Query Parameters

type

enum<string> | null

Available options:

image,

audio,

video,

text_to_speech,

speech_to_speech,

voice_clone,

audio_isolation,

video_stitching,

agent_response

created_before

string<date-time> | null

created_after

string<date-time> | null

paging_params

PagingParams · object

Show child attributes

paging_params.limit

integer

default:100

Number of items returned in the page.

paging_params.offset

integer

default:0

Number of records skipped.

ids

string | null

Response

Successful Response

page_info

PageInfo · object

required

Paging information.

Show child attributes

page_info.limit

integer

required

Number of items returned in the page.

page_info.offset

integer

required

Number of records skipped.

data

Generation · object[]

required

Page data.

Show child attributes

data.id

string<uuid>

required

ID of the generation and associated asset.

data.type

enum<string>

required

Type of generation.

Available options:

image,

audio,

video,

voice

data.input

GenerateVideoRequest · object

required

Inputs for the generation

GenerateVideoRequest
GenerateTextToSpeechRequest
GenerateImageRequest
GenerateIsolatedAudioRequest
GenerateSpeechToSpeechRequest
GenerateVoiceCloneRequest

Show child attributes

data.input.generated_video_inputs

GeneratedVideoInputs · object

required

Inputs for generating the video.

Show child attributes

data.input.generated_video_inputs.text_prompt

string

required

Prompt for video generation.

data.input.generated_video_inputs.resolution

string | null

Resolution for the video.

data.input.generated_video_inputs.aspect_ratio

string | null

Aspect ratio for the video.

data.input.generated_video_inputs.duration_ms

integer | null

default:0

Duration of the video in milliseconds.

data.input.generated_video_inputs.bounding_box_target

any[] | null

Normalized coordinates for primary speaker position (Character3 only)

Required array length: 2 elements

data.input.type

string

default:video

Allowed value: "video"

data.input.ai_model_id

string<uuid>

default:d1dd37a3-e39a-4854-a298-6510289f9cf2

ID of the model to use for the generation.

data.input.start_keyframe_id

string<uuid> | null

The id of the Image asset to use as the start keyframe.

data.input.audio_id

string<uuid> | null

The id of the Audio asset to use.

data.status

enum<string>

required

Status of the generation

Available options:

complete,

error,

processing,

finalizing,

queued,

pending

data.progress

number

required

Current progress to completion. Between 0-1

data.created_at

string<date-time>

required

Date the generation was submitted.

data.asset

Asset · object

The generated asset. Value is not present unless the status of the generation is 'complete'

Show child attributes

data.asset.id

string<uuid>

required

The id of the asset.

data.asset.type

enum<string>

required

The type of the asset.

Available options:

image,

audio,

video,

voice

data.asset.name

string

required

Name of the asset. Default to user-provided file name.

data.asset.thumbnail_url

string

required

URL of the thumbnail image.

data.asset.created_at

string<date-time>

required

Date the asset was created.

data.asset.asset

UploadedImage · object

required

The asset itself.

UploadedImage
UploadedAudio
GeneratedAudio
GeneratedImage
GeneratedVideo
Voice

Show child attributes

data.asset.asset.width

integer

required

Width of the image.

data.asset.asset.height

integer

required

Height of the image.

data.asset.asset.url

string

required

URL of the image.

data.asset.asset.type

string

default:uploaded_image

Allowed value: "uploaded_image"

data.asset.description

string | null

Optional description of the asset.

data.asset.is_favorite

boolean

default:false

Whether the asset is favorited by the user.

data.error_message

string | null

Error message. Value is not present unless the status of the generation is 'error'

Upload Asset Generate Asset

⌘I

Public

Authorizations

Query Parameters

Response