@hedra/sdk 1.0.0

package/dist/cjs/api/types/VoiceListResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface VoiceListResponse {
+    /** This page of items. */
+    data: Hedra.VoiceSummary[];
+    /** Opaque cursor for the next page, or null when this response completes the list. Always present. Endpoints that serve the whole collection at once always return null. */
+    next_cursor: string | null;
+}

package/dist/cjs/api/types/VoiceListResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/VoiceSummary.d.ts

@@ -0,0 +1,13 @@
+/**
+ * One voice a model accepts; `id` goes into ``input.voice_id`` on submit.
+ */
+export interface VoiceSummary {
+    /** The voice's id (`voice_<uuid>`); pass it as `input.voice_id` on submit. */
+    id: string;
+    /** Human-readable name. */
+    name?: (string | null) | undefined;
+    /** URL of a short audio sample of this voice. */
+    preview_url?: (string | null) | undefined;
+    /** Curation metadata (language, gender, accent, ...). */
+    labels?: Record<string, string> | undefined;
+}

package/dist/cjs/api/types/VoiceSummary.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookDefaultConfig.d.ts

@@ -0,0 +1,10 @@
+export interface WebhookDefaultConfig {
+    /** The stored default endpoint; null when none is configured. */
+    url?: (string | null) | undefined;
+    /** Whether the default endpoint is active. */
+    enabled?: boolean | undefined;
+    /** ISO-8601 instant the config last changed. */
+    updated_at?: (string | null) | undefined;
+    /** The API key that last changed the config. */
+    updated_by_key_id?: (string | null) | undefined;
+}

package/dist/cjs/api/types/WebhookDefaultConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookDeliveryListResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface WebhookDeliveryListResponse {
+    /** This page of items. */
+    data: Hedra.WebhookDeliverySummary[];
+    /** Opaque cursor for the next page, or null when this response completes the list. Always present. Endpoints that serve the whole collection at once always return null. */
+    next_cursor: string | null;
+}

package/dist/cjs/api/types/WebhookDeliveryListResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookDeliverySource.d.ts

@@ -0,0 +1,6 @@
+/** Which URL resolution created this delivery. */
+export declare const WebhookDeliverySource: {
+    readonly PerJob: "per_job";
+    readonly Default: "default";
+};
+export type WebhookDeliverySource = (typeof WebhookDeliverySource)[keyof typeof WebhookDeliverySource];

package/dist/cjs/api/types/WebhookDeliverySource.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookDeliverySource = void 0;
+/** Which URL resolution created this delivery. */
+exports.WebhookDeliverySource = {
+    PerJob: "per_job",
+    Default: "default",
+};

package/dist/cjs/api/types/WebhookDeliveryStatus.d.ts

@@ -0,0 +1,8 @@
+/** Where a delivery stands: queued, in flight, or its terminal outcome. */
+export declare const WebhookDeliveryStatus: {
+    readonly Pending: "PENDING";
+    readonly Delivering: "DELIVERING";
+    readonly Delivered: "DELIVERED";
+    readonly Failed: "FAILED";
+};
+export type WebhookDeliveryStatus = (typeof WebhookDeliveryStatus)[keyof typeof WebhookDeliveryStatus];

package/dist/cjs/api/types/WebhookDeliveryStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookDeliveryStatus = void 0;
+/** Where a delivery stands: queued, in flight, or its terminal outcome. */
+exports.WebhookDeliveryStatus = {
+    Pending: "PENDING",
+    Delivering: "DELIVERING",
+    Delivered: "DELIVERED",
+    Failed: "FAILED",
+};

package/dist/cjs/api/types/WebhookDeliverySummary.d.ts

@@ -0,0 +1,29 @@
+import type * as Hedra from "../index.js";
+export interface WebhookDeliverySummary {
+    /** The job whose terminal event this delivers. */
+    job_id: string;
+    /** Whether GET /v3/jobs/{job_id} works for the caller — false when the job belongs to a different owner than the authenticating key. */
+    job_accessible: boolean;
+    /** The resolved model id the job ran on. */
+    model: string;
+    /** The terminal event this delivery announces; null until the delivery fires — a row registered at submit has no outcome to announce while its job is still running. */
+    event_type?: (Hedra.WebhookEventType | null) | undefined;
+    status: Hedra.WebhookDeliveryStatus;
+    source: Hedra.WebhookDeliverySource;
+    /** Delivery attempts so far, cumulative across replays. */
+    attempts: number;
+    /** How many operator replays this delivery has had; 0 means every attempt was automatic. */
+    redelivery_count?: number | undefined;
+    /** One entry per operator replay, oldest first — each holds the delivery's fields as they stood when the replay was requested. Replays recorded before this history existed appear only in `redelivery_count`, so the list can be shorter. */
+    redeliveries?: Hedra.WebhookRedelivery[] | undefined;
+    /** HTTP status of the most recent attempt; null when it never got a response. */
+    last_response_status?: (number | null) | undefined;
+    /** Why the most recent delivery attempt failed, in the same error envelope `GET /jobs/{job_id}` returns for a failed job: a stable `code` from the shared error vocabulary, a fixed operator-facing `message`, and `retryable`. Null while no attempt has failed. Destination URLs, addresses, headers, credentials, response bodies, and internal exception text are never included — those stay in Hedra's own logs. `retryable` describes the condition, not what Hedra did: every non-2xx response is retried on the published ladder, so it answers whether replaying this delivery is likely to help. Deliveries that failed before this field became structured report `UNKNOWN`. */
+    last_error?: (Hedra.ErrorEnvelope | null) | undefined;
+    /** The destination endpoint. */
+    webhook_url: string;
+    /** ISO-8601 instant the delivery was registered. */
+    created_at: string;
+    /** ISO-8601 instant of the most recent attempt; null before the first one. */
+    last_attempt_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/WebhookDeliverySummary.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookEventType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The terminal events an outbound webhook announces.
+ *
+ * One delivery carries exactly one of these, chosen from the job's final
+ * status when the delivery fires.
+ */
+export declare const WebhookEventType: {
+    readonly JobCompleted: "job.completed";
+    readonly JobFailed: "job.failed";
+};
+export type WebhookEventType = (typeof WebhookEventType)[keyof typeof WebhookEventType];

package/dist/cjs/api/types/WebhookEventType.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookEventType = void 0;
+/**
+ * The terminal events an outbound webhook announces.
+ *
+ * One delivery carries exactly one of these, chosen from the job's final
+ * status when the delivery fires.
+ */
+exports.WebhookEventType = {
+    JobCompleted: "job.completed",
+    JobFailed: "job.failed",
+};

package/dist/cjs/api/types/WebhookPayload.d.ts

@@ -0,0 +1,21 @@
+import type * as Hedra from "../index.js";
+/**
+ * Body of a webhook delivery: the `GET /jobs/{job_id}` result envelope without its poll-only fields (`logs`, `cost`, `currency`) — poll the job to read those.
+ */
+export interface WebhookPayload {
+    /** The job this envelope describes. */
+    job_id: string;
+    /** The resolved model id this job ran on. */
+    model: string;
+    /** The quality level this job ran at; present only for models that offer quality levels. */
+    quality?: (string | null) | undefined;
+    status: Hedra.JobStatus;
+    /** The prompt this job ran with. When `enhance_prompt` was set, this is the rewritten prompt the model received rather than the one submitted. Absent on models that take no prompt. */
+    prompt?: (string | null) | undefined;
+    /** The job's outputs — always an array, even for a single output; empty until the job completes. */
+    outputs?: Hedra.OutputItem[] | undefined;
+    /** Timing for this job; present on completed jobs only. */
+    metrics?: (Hedra.Metrics | null) | undefined;
+    /** Why the job failed; null unless `status` is `FAILED`. */
+    error?: (Hedra.ErrorEnvelope | null) | undefined;
+}

package/dist/cjs/api/types/WebhookPayload.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookPublicKey.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The ed25519 public key callers verify outbound webhook signatures with.
+ */
+export interface WebhookPublicKey {
+    /** Signature algorithm; always `ed25519`. */
+    algorithm?: string | undefined;
+    /** Base64-encoded ed25519 public key. Verify each delivery's signature header with it before trusting the payload. */
+    public_key: string;
+}

package/dist/cjs/api/types/WebhookPublicKey.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookRedelivery.d.ts

@@ -0,0 +1,19 @@
+import type * as Hedra from "../index.js";
+/**
+ * The outcome a replay superseded: the delivery's own fields as they stood
+ * when the operator requested the redelivery. Only finished deliveries can be
+ * replayed, so `status` is always terminal (`DELIVERED` / `FAILED`).
+ */
+export interface WebhookRedelivery {
+    /** ISO-8601 instant the redelivery was requested. */
+    requested_at: string;
+    status: Hedra.WebhookDeliveryStatus;
+    /** Cumulative attempt count as it stood when this replay was requested. */
+    attempts: number;
+    /** HTTP status of the superseded cycle's last attempt; null when it never got a response. */
+    last_response_status?: (number | null) | undefined;
+    /** Why the most recent delivery attempt failed, in the same error envelope `GET /jobs/{job_id}` returns for a failed job: a stable `code` from the shared error vocabulary, a fixed operator-facing `message`, and `retryable`. Null while no attempt has failed. Destination URLs, addresses, headers, credentials, response bodies, and internal exception text are never included — those stay in Hedra's own logs. `retryable` describes the condition, not what Hedra did: every non-2xx response is retried on the published ladder, so it answers whether replaying this delivery is likely to help. Deliveries that failed before this field became structured report `UNKNOWN`. */
+    last_error?: (Hedra.ErrorEnvelope | null) | undefined;
+    /** ISO-8601 instant of the superseded cycle's last attempt. */
+    last_attempt_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/WebhookRedelivery.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WebhookTestResponse.d.ts

@@ -0,0 +1,8 @@
+export interface WebhookTestResponse {
+    /** Whether the test delivery got a 2xx from the endpoint. */
+    ok: boolean;
+    /** HTTP status the endpoint returned; null when the request never got a response. */
+    response_status?: (number | null) | undefined;
+    /** Why the test failed; null on success. */
+    error?: (string | null) | undefined;
+}

package/dist/cjs/api/types/WebhookTestResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/index.d.ts

@@ -0,0 +1,231 @@
+export * from "./ApiKeyKind.js";
+export * from "./ApiKeyScope.js";
+export * from "./BalanceResponse.js";
+export * from "./BillingError.js";
+export * from "./ErrorCode.js";
+export * from "./ErrorEnvelope.js";
+export * from "./ErrorResponse.js";
+export * from "./EstimateResponse.js";
+export * from "./FieldError.js";
+export * from "./FileUploadResponse.js";
+export * from "./InputDreamina31.js";
+export * from "./InputElevenlabsFlashMultilingualV2.js";
+export * from "./InputElevenlabsFlashV2.js";
+export * from "./InputElevenlabsMultilingualV2.js";
+export * from "./InputElevenlabsV3.js";
+export * from "./InputFlux2Flex.js";
+export * from "./InputFlux2FlexImagesItem.js";
+export * from "./InputFlux2Klein9B.js";
+export * from "./InputFlux2Klein9BImagesItem.js";
+export * from "./InputFlux2Max.js";
+export * from "./InputFlux2MaxImagesItem.js";
+export * from "./InputFlux2Pro.js";
+export * from "./InputFlux2ProImagesItem.js";
+export * from "./InputFlux3.js";
+export * from "./InputFlux3EndImage.js";
+export * from "./InputFlux3StartImage.js";
+export * from "./InputFlux11Pro.js";
+export * from "./InputFlux11Ultra.js";
+export * from "./InputFluxDev.js";
+export * from "./InputFluxKontextMax.js";
+export * from "./InputFluxKontextMaxImagesItem.js";
+export * from "./InputFluxKontextPro.js";
+export * from "./InputFluxKontextProImagesItem.js";
+export * from "./InputGeminiOmniFlash.js";
+export * from "./InputGeminiOmniFlashImagesItem.js";
+export * from "./InputGeminiOmniFlashSourceVideo.js";
+export * from "./InputGeminiOmniFlashStartImage.js";
+export * from "./InputGeminiOmniFlashVideosItem.js";
+export * from "./InputGptImage2.js";
+export * from "./InputGptImage2ImagesItem.js";
+export * from "./InputGptImage15.js";
+export * from "./InputGptImage15ImagesItem.js";
+export * from "./InputGrokImagine.js";
+export * from "./InputGrokImagineImagesItem.js";
+export * from "./InputGrokVideo.js";
+export * from "./InputGrokVideoStartImage.js";
+export * from "./InputHappyHorse.js";
+export * from "./InputHappyHorseImagesItem.js";
+export * from "./InputHappyHorseStartImage.js";
+export * from "./InputHedraAvatar.js";
+export * from "./InputHedraAvatarAudioOneItem.js";
+export * from "./InputHedraAvatarAudioZero.js";
+export * from "./InputHedraAvatarStartImage.js";
+export * from "./InputHedraCharacter3.js";
+export * from "./InputHedraCharacter3AudioOneItem.js";
+export * from "./InputHedraCharacter3AudioZero.js";
+export * from "./InputHedraCharacter3StartImage.js";
+export * from "./InputHidreamO1Image.js";
+export * from "./InputHidreamO1ImageImagesItem.js";
+export * from "./InputIdeogramV2.js";
+export * from "./InputIdeogramV4.js";
+export * from "./InputImagen3.js";
+export * from "./InputImagen4.js";
+export * from "./InputKling16.js";
+export * from "./InputKling16StartImage.js";
+export * from "./InputKling21Master.js";
+export * from "./InputKling21MasterStartImage.js";
+export * from "./InputKling25Turbo.js";
+export * from "./InputKling25TurboStartImage.js";
+export * from "./InputKling26MotionControl.js";
+export * from "./InputKling26MotionControlSourceVideo.js";
+export * from "./InputKling26MotionControlStartImage.js";
+export * from "./InputKling26Pro.js";
+export * from "./InputKling26ProStartImage.js";
+export * from "./InputKlingAiAvatarV2.js";
+export * from "./InputKlingAiAvatarV2Audio.js";
+export * from "./InputKlingAiAvatarV2StartImage.js";
+export * from "./InputKlingO1.js";
+export * from "./InputKlingO1EndImage.js";
+export * from "./InputKlingO1ImagesItem.js";
+export * from "./InputKlingO1StartImage.js";
+export * from "./InputKlingO3.js";
+export * from "./InputKlingO3Edit.js";
+export * from "./InputKlingO3EditImagesItem.js";
+export * from "./InputKlingO3EditSourceVideo.js";
+export * from "./InputKlingO3EndImage.js";
+export * from "./InputKlingO3ImagesItem.js";
+export * from "./InputKlingO3Reference.js";
+export * from "./InputKlingO3ReferenceImagesItem.js";
+export * from "./InputKlingO3ReferenceSourceVideo.js";
+export * from "./InputKlingO3StartImage.js";
+export * from "./InputKlingV3.js";
+export * from "./InputKlingV3EndImage.js";
+export * from "./InputKlingV3MotionControl.js";
+export * from "./InputKlingV3MotionControlSourceVideo.js";
+export * from "./InputKlingV3MotionControlStartImage.js";
+export * from "./InputKlingV3StartImage.js";
+export * from "./InputLtx23.js";
+export * from "./InputLtx23EndImage.js";
+export * from "./InputLtx23StartImage.js";
+export * from "./InputLumaRay32.js";
+export * from "./InputMaiImage25.js";
+export * from "./InputMaiImage25ImagesItem.js";
+export * from "./InputMinimaxH3.js";
+export * from "./InputMinimaxH3AudiosItem.js";
+export * from "./InputMinimaxH3EndImage.js";
+export * from "./InputMinimaxH3ImagesItem.js";
+export * from "./InputMinimaxH3StartImage.js";
+export * from "./InputMinimaxH3VideosItem.js";
+export * from "./InputMinimaxHailuo02.js";
+export * from "./InputMinimaxHailuo02EndImage.js";
+export * from "./InputMinimaxHailuo02StartImage.js";
+export * from "./InputMinimaxHailuo23.js";
+export * from "./InputMinimaxHailuo23StartImage.js";
+export * from "./InputMinimaxSpeech25HdPreview.js";
+export * from "./InputMinimaxSpeech25TurboPreview.js";
+export * from "./InputNanoBanana.js";
+export * from "./InputNanoBanana2.js";
+export * from "./InputNanoBanana2ImagesItem.js";
+export * from "./InputNanoBananaImagesItem.js";
+export * from "./InputNanoBananaPro.js";
+export * from "./InputNanoBananaProImagesItem.js";
+export * from "./InputOmnihuman15.js";
+export * from "./InputOmnihuman15Audio.js";
+export * from "./InputOmnihuman15StartImage.js";
+export * from "./InputPixverseV6.js";
+export * from "./InputPixverseV6StartImage.js";
+export * from "./InputQwenImage2.js";
+export * from "./InputQwenImage2ImagesItem.js";
+export * from "./InputRecraftV3.js";
+export * from "./InputReve21.js";
+export * from "./InputReve21Edit.js";
+export * from "./InputReve21EditImagesItem.js";
+export * from "./InputReve21Remix.js";
+export * from "./InputReve21RemixImagesItem.js";
+export * from "./InputSana.js";
+export * from "./InputSeedance15Pro.js";
+export * from "./InputSeedance15ProEndImage.js";
+export * from "./InputSeedance15ProStartImage.js";
+export * from "./InputSeedance20.js";
+export * from "./InputSeedance20AudiosItem.js";
+export * from "./InputSeedance20EndImage.js";
+export * from "./InputSeedance20ImagesItem.js";
+export * from "./InputSeedance20Mini.js";
+export * from "./InputSeedance20MiniAudiosItem.js";
+export * from "./InputSeedance20MiniEndImage.js";
+export * from "./InputSeedance20MiniImagesItem.js";
+export * from "./InputSeedance20MiniStartImage.js";
+export * from "./InputSeedance20MiniVideosItem.js";
+export * from "./InputSeedance20StartImage.js";
+export * from "./InputSeedance20VideosItem.js";
+export * from "./InputSeedance25.js";
+export * from "./InputSeedance25AudiosItem.js";
+export * from "./InputSeedance25EndImage.js";
+export * from "./InputSeedance25ImagesItem.js";
+export * from "./InputSeedance25StartImage.js";
+export * from "./InputSeedance25VideosItem.js";
+export * from "./InputSeedream40.js";
+export * from "./InputSeedream40ImagesItem.js";
+export * from "./InputSeedream45.js";
+export * from "./InputSeedream45ImagesItem.js";
+export * from "./InputSeedream50Lite.js";
+export * from "./InputSeedream50LiteImagesItem.js";
+export * from "./InputSeedream50Pro.js";
+export * from "./InputSeedream50ProImagesItem.js";
+export * from "./InputSora2Pro.js";
+export * from "./InputSora2ProStartImage.js";
+export * from "./InputVeedFabric10.js";
+export * from "./InputVeedFabric10Audio.js";
+export * from "./InputVeedFabric10StartImage.js";
+export * from "./InputVeo2.js";
+export * from "./InputVeo2StartImage.js";
+export * from "./InputVeo3.js";
+export * from "./InputVeo3StartImage.js";
+export * from "./InputVeo31.js";
+export * from "./InputVeo31EndImage.js";
+export * from "./InputVeo31ImagesItem.js";
+export * from "./InputVeo31SourceVideo.js";
+export * from "./InputVeo31StartImage.js";
+export * from "./InputViduQ3.js";
+export * from "./InputViduQ3EndImage.js";
+export * from "./InputViduQ3Reference.js";
+export * from "./InputViduQ3ReferenceImagesItem.js";
+export * from "./InputViduQ3StartImage.js";
+export * from "./InputWan27.js";
+export * from "./InputWan27EndImage.js";
+export * from "./InputWan27ImagesItem.js";
+export * from "./InputWan27StartImage.js";
+export * from "./JobListResponse.js";
+export * from "./JobLogEvent.js";
+export * from "./JobLogItem.js";
+export * from "./JobLogLevel.js";
+export * from "./JobLogListResponse.js";
+export * from "./JobLogSource.js";
+export * from "./JobStatus.js";
+export * from "./JobSummary.js";
+export * from "./KeyCreateResponse.js";
+export * from "./KeyListResponse.js";
+export * from "./KeyRotateResponse.js";
+export * from "./KeyStatus.js";
+export * from "./KeySummary.js";
+export * from "./LogDrainConfig.js";
+export * from "./LogDrainFormat.js";
+export * from "./LogDrainListResponse.js";
+export * from "./LogDrainTestResponse.js";
+export * from "./Metrics.js";
+export * from "./Modality.js";
+export * from "./ModelDetail.js";
+export * from "./ModelListResponse.js";
+export * from "./ModelSummary.js";
+export * from "./OutputItem.js";
+export * from "./OutputStatus.js";
+export * from "./ResultResponse.js";
+export * from "./StatusResponse.js";
+export * from "./SubmitResponse.js";
+export * from "./TokenCreateResponse.js";
+export * from "./UsageBucket.js";
+export * from "./UsageGroupBy.js";
+export * from "./UsageResponse.js";
+export * from "./VoiceListResponse.js";
+export * from "./VoiceSummary.js";
+export * from "./WebhookDefaultConfig.js";
+export * from "./WebhookDeliveryListResponse.js";
+export * from "./WebhookDeliverySource.js";
+export * from "./WebhookDeliveryStatus.js";
+export * from "./WebhookDeliverySummary.js";
+export * from "./WebhookEventType.js";
+export * from "./WebhookPayload.js";
+export * from "./WebhookPublicKey.js";
+export * from "./WebhookRedelivery.js";
+export * from "./WebhookTestResponse.js";