@hedra/sdk 1.0.0

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

@@ -0,0 +1,17 @@
+import type * as Hedra from "../index.js";
+/**
+ * One customer-visible lifecycle event for a v3 job.
+ */
+export interface JobLogItem {
+    /** Monotonically increasing id of this event within the job's log. Cursors are separate opaque values (`next_cursor` / `logs_next_cursor`); do not send this id as one. */
+    id: number;
+    /** ISO-8601 instant the event was recorded. */
+    timestamp: string;
+    level: Hedra.JobLogLevel;
+    event: Hedra.JobLogEvent;
+    /** Human-readable summary of the event. */
+    message: string;
+    source: Hedra.JobLogSource;
+    /** Structured detail specific to this event type; empty when the event carries none. */
+    data?: Record<string, unknown> | undefined;
+}

package/dist/cjs/api/types/JobLogItem.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/JobLogLevel.d.ts

@@ -0,0 +1,6 @@
+export declare const JobLogLevel: {
+    readonly Info: "info";
+    readonly Warning: "warning";
+    readonly Error: "error";
+};
+export type JobLogLevel = (typeof JobLogLevel)[keyof typeof JobLogLevel];

package/dist/cjs/api/types/JobLogLevel.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.JobLogLevel = void 0;
+exports.JobLogLevel = {
+    Info: "info",
+    Warning: "warning",
+    Error: "error",
+};

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

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface JobLogListResponse {
+    /** This page of items. */
+    data: Hedra.JobLogItem[];
+    /** 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/JobLogListResponse.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/JobLogSource.d.ts

@@ -0,0 +1,7 @@
+export declare const JobLogSource: {
+    readonly Api: "api";
+    readonly Worker: "worker";
+    readonly Provider: "provider";
+    readonly Cron: "cron";
+};
+export type JobLogSource = (typeof JobLogSource)[keyof typeof JobLogSource];

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

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobLogSource = void 0;
+exports.JobLogSource = {
+    Api: "api",
+    Worker: "worker",
+    Provider: "provider",
+    Cron: "cron",
+};

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

@@ -0,0 +1,8 @@
+/** The four states a job can be in. */
+export declare const JobStatus: {
+    readonly InQueue: "IN_QUEUE";
+    readonly InProgress: "IN_PROGRESS";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];

package/dist/cjs/api/types/JobStatus.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.JobStatus = void 0;
+/** The four states a job can be in. */
+exports.JobStatus = {
+    InQueue: "IN_QUEUE",
+    InProgress: "IN_PROGRESS",
+    Completed: "COMPLETED",
+    Failed: "FAILED",
+};

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

@@ -0,0 +1,12 @@
+import type * as Hedra from "../index.js";
+export interface JobSummary {
+    /** The job's id — server-issued, and opaque. */
+    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;
+    /** ISO-8601 instant the job was submitted. */
+    created_at: string;
+}

package/dist/cjs/api/types/JobSummary.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/KeyCreateResponse.d.ts

@@ -0,0 +1,18 @@
+import type * as Hedra from "../index.js";
+export interface KeyCreateResponse {
+    /** The key's public identifier. */
+    key_id: string;
+    /** The full `<key_id>:<secret>` pair — a valid Bearer credential. Returned exactly once, at creation; store it now. */
+    credential: string;
+    kind: Hedra.ApiKeyKind;
+    /** Human-readable label for the key. */
+    name?: (string | null) | undefined;
+    /** Scopes granted to the key; null means full access (a legacy key predating scopes). */
+    scopes?: (string[] | null) | undefined;
+    /** The workspace the key bills and acts in. */
+    workspace_id?: (string | null) | undefined;
+    /** ISO-8601 instant the key stops authenticating; null means it never expires. */
+    expires_at?: (string | null) | undefined;
+    /** ISO-8601 instant the key was created. */
+    created_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/KeyCreateResponse.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/KeyListResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface KeyListResponse {
+    /** This page of items. */
+    data: Hedra.KeySummary[];
+    /** 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/KeyListResponse.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/KeyRotateResponse.d.ts

@@ -0,0 +1,18 @@
+import type * as Hedra from "../index.js";
+export interface KeyRotateResponse {
+    /** The key's public identifier — unchanged by rotation. */
+    key_id: string;
+    /** The new `<key_id>:<secret>` pair — a valid Bearer credential, shown exactly once, like at create. */
+    credential: string;
+    kind: Hedra.ApiKeyKind;
+    /** Human-readable label for the key. */
+    name?: (string | null) | undefined;
+    /** Scopes granted to the key; null means full access (a legacy key predating scopes). */
+    scopes?: (string[] | null) | undefined;
+    /** The workspace the key bills and acts in. */
+    workspace_id?: (string | null) | undefined;
+    /** ISO-8601 instant the key stops authenticating; null means it never expires. */
+    expires_at?: (string | null) | undefined;
+    /** ISO-8601 instant the previous secret stops authenticating — the end of the grace window. */
+    previous_secret_expires_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/KeyRotateResponse.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/KeyStatus.d.ts

@@ -0,0 +1,6 @@
+export declare const KeyStatus: {
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+    readonly Expired: "expired";
+};
+export type KeyStatus = (typeof KeyStatus)[keyof typeof KeyStatus];

package/dist/cjs/api/types/KeyStatus.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.KeyStatus = void 0;
+exports.KeyStatus = {
+    Active: "active",
+    Revoked: "revoked",
+    Expired: "expired",
+};

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

@@ -0,0 +1,21 @@
+import type * as Hedra from "../index.js";
+export interface KeySummary {
+    /** The key's public identifier; null only for legacy rows predating public key ids. */
+    key_id: string | null;
+    kind: Hedra.ApiKeyKind;
+    /** Human-readable label for the key. */
+    name?: (string | null) | undefined;
+    /** Scopes granted to the key; null means full access (a legacy key predating scopes). */
+    scopes?: (string[] | null) | undefined;
+    /** The workspace the key bills and acts in. */
+    workspace_id?: (string | null) | undefined;
+    status: Hedra.KeyStatus;
+    /** ISO-8601 instant the key was created. */
+    created_at?: (string | null) | undefined;
+    /** ISO-8601 instant the key stops authenticating; null means it never expires. */
+    expires_at?: (string | null) | undefined;
+    /** ISO-8601 instant the key was revoked; null unless `status` is `revoked`. */
+    revoked_at?: (string | null) | undefined;
+    /** ISO-8601 instant the key last authenticated a request; null when unused. */
+    last_used_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/KeySummary.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/LogDrainConfig.d.ts

@@ -0,0 +1,34 @@
+import type * as Hedra from "../index.js";
+export interface LogDrainConfig {
+    /** The drain's id (`drain_<uuid>`). */
+    id: string;
+    /** Human-readable label. */
+    name: string;
+    /** The destination endpoint. */
+    url: string;
+    format: Hedra.LogDrainFormat;
+    /** Names of the configured extra headers. Values are write-only and never echoed back. */
+    header_names?: string[] | undefined;
+    /** Whether the drain receives batches. */
+    enabled: boolean;
+    /** Maximum log lines per post. */
+    batch_size: number;
+    /** Failed batches since the last success; the drain auto-disables when it crosses the failure threshold. */
+    consecutive_failures: number;
+    /** ISO-8601 instant of the last delivered batch. */
+    last_success_at?: (string | null) | undefined;
+    /** ISO-8601 instant of the last failed batch. */
+    last_failure_at?: (string | null) | undefined;
+    /** HTTP status of the last failed batch; null when it never got a response. */
+    last_failure_status?: (number | null) | undefined;
+    /** Why the most recent batch delivery 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 batch has failed, and cleared on the next success. Destination URLs, headers, credentials, response bodies, and internal exception text are never included. Nor is your drain URL written to Hedra's own logs, since it may carry authentication in its query string. `retryable` describes the condition, not what Hedra did: every failed batch is requeued until the drain auto-disables, so it answers whether fixing the destination and re-enabling is likely to help. Drains that last failed before this field became structured report `UNKNOWN`. */
+    last_error?: (Hedra.ErrorEnvelope | null) | undefined;
+    /** Why the drain is off (`consecutive_failures` for auto-disable, `disabled_by_user`); null while enabled. */
+    disabled_reason?: (string | null) | undefined;
+    /** ISO-8601 instant the drain was created. */
+    created_at: string;
+    /** ISO-8601 instant the config last changed. */
+    updated_at: string;
+    /** The API key that last changed the config. */
+    updated_by_key_id?: (string | null) | undefined;
+}

package/dist/cjs/api/types/LogDrainConfig.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/LogDrainFormat.d.ts

@@ -0,0 +1,6 @@
+/** Wire encoding for one log drain endpoint's HTTP posts. */
+export declare const LogDrainFormat: {
+    readonly Ndjson: "ndjson";
+    readonly Otlp: "otlp";
+};
+export type LogDrainFormat = (typeof LogDrainFormat)[keyof typeof LogDrainFormat];

package/dist/cjs/api/types/LogDrainFormat.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.LogDrainFormat = void 0;
+/** Wire encoding for one log drain endpoint's HTTP posts. */
+exports.LogDrainFormat = {
+    Ndjson: "ndjson",
+    Otlp: "otlp",
+};

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

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface LogDrainListResponse {
+    /** This page of items. */
+    data: Hedra.LogDrainConfig[];
+    /** 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/LogDrainListResponse.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/LogDrainTestResponse.d.ts

@@ -0,0 +1,8 @@
+export interface LogDrainTestResponse {
+    /** Whether the test batch 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/LogDrainTestResponse.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/Metrics.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Timing measured for a completed job.
+ */
+export interface Metrics {
+    /** Wall-clock milliseconds between this job's `started` and `completed` lifecycle events. It brackets provider queueing, generation, output download, and any failed attempts with their retry backoff, so it measures the whole job rather than the model's own inference time, and it is not a provider-reported figure. Read from the job's durable lifecycle records, so polled results and webhook deliveries report the same value. Null when the job did not record both events. */
+    processing_time_ms?: (number | null) | undefined;
+}

package/dist/cjs/api/types/Metrics.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/Modality.d.ts

@@ -0,0 +1,7 @@
+/** The kind of output a model produces — the axis `?modality=` filters on. */
+export declare const Modality: {
+    readonly Image: "image";
+    readonly Video: "video";
+    readonly Audio: "audio";
+};
+export type Modality = (typeof Modality)[keyof typeof Modality];

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

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Modality = void 0;
+/** The kind of output a model produces — the axis `?modality=` filters on. */
+exports.Modality = {
+    Image: "image",
+    Video: "video",
+    Audio: "audio",
+};

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

@@ -0,0 +1,16 @@
+import type * as Hedra from "../index.js";
+export interface ModelDetail {
+    /** The model's public id — the value POST /v3/models/{model} takes. */
+    id: string;
+    modality: Hedra.Modality;
+    /** Human-readable name. */
+    name?: (string | null) | undefined;
+    /** One-line summary of what the model does. */
+    description?: (string | null) | undefined;
+    /** URL of the provider's logo. */
+    logo_url?: (string | null) | undefined;
+    /** JSON Schema for this model's `input` object on submit — the same schema `GET /v3/models/{model}/openapi.json` embeds. */
+    input_schema?: Record<string, unknown> | undefined;
+    /** JSON Schema of one item of a completed job's `outputs[]`. */
+    output_schema?: Record<string, unknown> | undefined;
+}

package/dist/cjs/api/types/ModelDetail.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/ModelListResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as Hedra from "../index.js";
+export interface ModelListResponse {
+    /** This page of items. */
+    data: Hedra.ModelSummary[];
+    /** 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/ModelListResponse.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/ModelSummary.d.ts

@@ -0,0 +1,12 @@
+import type * as Hedra from "../index.js";
+export interface ModelSummary {
+    /** The model's public id — the value POST /v3/models/{model} takes. */
+    id: string;
+    modality: Hedra.Modality;
+    /** Human-readable name. */
+    name?: (string | null) | undefined;
+    /** One-line summary of what the model does. */
+    description?: (string | null) | undefined;
+    /** URL of the provider's logo. */
+    logo_url?: (string | null) | undefined;
+}

package/dist/cjs/api/types/ModelSummary.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/OutputItem.d.ts

@@ -0,0 +1,30 @@
+import type * as Hedra from "../index.js";
+/**
+ * One item of a job's `outputs[]` (`GET /v3/jobs/{job_id}`). `outputs` is
+ * always an array, even for a single output.
+ *
+ * Every key is always present. The ones a modality carries no value for
+ * serialize as null — an image output reports `duration_ms: null` and
+ * `fps: null`, an audio output `width: null` — so the shape is one object
+ * rather than one per modality. `url` and `asset_id` go null on an expired
+ * output, which has metadata but no retrievable bytes.
+ */
+export interface OutputItem {
+    status?: Hedra.OutputStatus | undefined;
+    /** This output's asset id — server-issued, and opaque. Pass it as `{"source": "asset", "asset_id": ...}` in a later submit's media inputs to reuse this output as a reference. Null once the output has expired, since its bytes are no longer retrievable. */
+    asset_id?: (string | null) | undefined;
+    /** Presigned download URL for the output bytes. Null once the output has expired. */
+    url?: (string | null) | undefined;
+    /** MIME type of the output bytes. */
+    content_type?: (string | null) | undefined;
+    /** Width in pixels; null for an output with no frame (audio). */
+    width?: (number | null) | undefined;
+    /** Height in pixels; null for an output with no frame (audio). */
+    height?: (number | null) | undefined;
+    /** Duration in milliseconds; null for a still image. */
+    duration_ms?: (number | null) | undefined;
+    /** The video's measured frame rate; null for a non-video output and for a video that has not been probed yet. */
+    fps?: (number | null) | undefined;
+    /** Why this item failed — present on a failed item within an otherwise-completed batch. */
+    error?: (Hedra.ErrorEnvelope | null) | undefined;
+}

package/dist/cjs/api/types/OutputItem.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/OutputStatus.d.ts

@@ -0,0 +1,7 @@
+/** The state of a single output within a job's result. */
+export declare const OutputStatus: {
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+    readonly Expired: "EXPIRED";
+};
+export type OutputStatus = (typeof OutputStatus)[keyof typeof OutputStatus];

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

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutputStatus = void 0;
+/** The state of a single output within a job's result. */
+exports.OutputStatus = {
+    Completed: "COMPLETED",
+    Failed: "FAILED",
+    Expired: "EXPIRED",
+};

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

@@ -0,0 +1,24 @@
+import type * as Hedra from "../index.js";
+export interface ResultResponse {
+    /** 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;
+    /** The most recent lifecycle events for this job, oldest first. Capped; GET /v3/jobs/{job_id}/logs serves the full paginated history. Absent from webhook payloads. */
+    logs?: (Hedra.JobLogItem[] | null) | undefined;
+    /** Net cost of this job; 0 when fully refunded; absent until charged. Absent from webhook payloads. */
+    cost?: (number | null) | undefined;
+    /** ISO-4217 currency code for `cost`. Present exactly when `cost` is. */
+    currency?: (string | null) | undefined;
+}

package/dist/cjs/api/types/ResultResponse.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/StatusResponse.d.ts

@@ -0,0 +1,27 @@
+import type * as Hedra from "../index.js";
+/**
+ * The lightweight poll envelope, also the SSE ``status`` frame and the MCP
+ * progress notification payload.
+ *
+ * The two log fields are poll-only by construction, like ``cost`` on
+ * the result envelope: they are populated when — and only when — a
+ * ``GET /v3/jobs/{job_id}/status`` caller supplies a ``logs_after`` cursor, and
+ * they exclude when ``None``, so the frame the stream transports build from a
+ * Redis payload with no DB session is byte-identical to a log-free envelope.
+ * That was ENG-9693's reason for having no ``logs`` field at all; the stream
+ * now carries lifecycle rows as their own ``event: log`` frames instead of
+ * inside this one (ENG-9694), and MCP progress notifications stay status-only.
+ */
+export interface StatusResponse {
+    /** The job this status describes. */
+    job_id: string;
+    status: Hedra.JobStatus;
+    /** Fraction of the job completed, from 0 to 1 (not a percentage). Null when the job has not reported progress yet. */
+    progress?: (number | null) | undefined;
+    /** ISO-8601 instant this job is estimated to finish; null when no estimate exists for the model yet. Refreshed on every poll. */
+    estimated_completion_at?: (string | null) | undefined;
+    /** Lifecycle events newer than the `logs_after` cursor, oldest first. Present only when `logs_after` is supplied; absent from SSE status frames and MCP progress notifications. */
+    logs?: (Hedra.JobLogItem[] | null) | undefined;
+    /** Cursor to send as `logs_after` on the next poll. Absent when this poll delivered no new events — keep using the cursor you sent. */
+    logs_next_cursor?: (string | null) | undefined;
+}

package/dist/cjs/api/types/StatusResponse.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/SubmitResponse.d.ts

@@ -0,0 +1,14 @@
+import type * as Hedra from "../index.js";
+export interface SubmitResponse {
+    /** This job's id — server-issued, and opaque. */
+    job_id: string;
+    /** The resolved model id this job runs on. */
+    model: string;
+    status: Hedra.JobStatus;
+    /** Path of this job's status monitor: poll GET /v3/jobs/{job_id}/status for status, progress, and an estimate. */
+    status_url: string;
+    /** Path of the job resource itself: GET /v3/jobs/{job_id} returns the result envelope, including the outputs once it completes. Also the value of this response's `Location` header. */
+    result_url: string;
+    /** ISO-8601 instant this job is estimated to finish. Null when no estimate exists for the model yet; poll GET /v3/jobs/{job_id}/status for a refreshed one. */
+    estimated_completion_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/SubmitResponse.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/TokenCreateResponse.d.ts

@@ -0,0 +1,6 @@
+export interface TokenCreateResponse {
+    /** The ephemeral token — a valid Bearer credential until it expires. Shown exactly once. */
+    token: string;
+    /** ISO-8601 instant the token stops authenticating. */
+    expires_at?: (string | null) | undefined;
+}

package/dist/cjs/api/types/TokenCreateResponse.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/UsageBucket.d.ts

@@ -0,0 +1,13 @@
+/**
+ * One usage rollup row. `key` is ``"total"`` for the summary, an ISO date
+ * (``YYYY-MM-DD``, UTC) for ``group_by=day``, or a public model id for
+ * ``group_by=model``.
+ */
+export interface UsageBucket {
+    /** What this bucket rolls up: `"total"`, an ISO date (`YYYY-MM-DD`, UTC), or a public model id — per `group_by`. */
+    key: string;
+    /** Jobs submitted in this bucket. */
+    jobs: number;
+    /** Net amount spent in this bucket. */
+    spent: number;
+}

package/dist/cjs/api/types/UsageBucket.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/UsageGroupBy.d.ts

@@ -0,0 +1,6 @@
+export declare const UsageGroupBy: {
+    readonly Total: "total";
+    readonly Day: "day";
+    readonly Model: "model";
+};
+export type UsageGroupBy = (typeof UsageGroupBy)[keyof typeof UsageGroupBy];

package/dist/cjs/api/types/UsageGroupBy.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.UsageGroupBy = void 0;
+exports.UsageGroupBy = {
+    Total: "total",
+    Day: "day",
+    Model: "model",
+};

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

@@ -0,0 +1,16 @@
+import type * as Hedra from "../index.js";
+export interface UsageResponse {
+    /** Window start (inclusive). */
+    start: string;
+    /** Window end (exclusive). */
+    end: string;
+    group_by: Hedra.UsageGroupBy;
+    /** Jobs submitted across the whole window. */
+    total_jobs: number;
+    /** Net amount spent across the whole window. */
+    total_spent: number;
+    /** ISO-4217 currency code for every amount in this response. */
+    currency: string;
+    /** One bucket per `group_by` group. */
+    data?: Hedra.UsageBucket[] | undefined;
+}

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

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