Skip to content
Darkroom0.3.1
API reference

app-media-contracts

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/darkroom/app-media-contracts";

Exports

Section titled “Exports”
Kind Export Description
constant mediaModelsSchema Bounded catalog decoded by the App media broker before host filtering.
constant destinationSchema An absolute output path on the Computer admitted by the App host.
constant appMediaGenerationResultSchema Completed App generation output, with its admitted Computer destination.
constant appMediaAdmissionErrorSchema Authority refusals emitted by Media admission before a host call.
constant appMediaBudgetRefusalSchema Attachment budget refusal emitted by the Media reservation owner.
constant appMediaAdmissionRefusalSchema Existing Media admission refusals, without an admitted selector or callable.
constant appMediaBrokerErrorSchema Admission errors plus invalid/oversized inputs emitted directly by the broker.
constant agentAppMediaLibraryFailureSchema Missing-library refusal decoded and returned by the App media broker.
constant appMediaBrokerFailureSchema Broker projection of an HTTP failure: code becomes error and error becomes message.
constant appMediaRefusalSchema Refusal payloads emitted by the App media broker, separate from transport errors.
constant appMediaModelsOutcomeSchema Model-list payload or an existing broker refusal.
constant appMediaGenerationOutcomeSchema Completed generation, Agar polling result, or an existing broker refusal.

mediaModelsSchemaconstant

Section titled “mediaModelsSchema”
Signature
const mediaModelsSchema: ZodLazy<ZodArray<ZodReadonly<ZodObject<{
  id: ZodString;
  label: ZodString;
  kind: ZodEnum<{
     image: "image";
     video: "video";
  }>;
  tier: ZodEnum<{
     draft: "draft";
     balanced: "balanced";
     premium: "premium";
     max: "max";
  }>;
  outputFormats: ZodReadonly<ZodArray<ZodEnum<{
     png: "png";
     jpeg: "jpeg";
     webp: "webp";
  }>>>;
  maxPromptLength: ZodNumber;
  input: ZodLazy<ZodReadonly<ZodObject<{
     transport: ZodEnum<{
        json: ...;
        multipart: ...;
     }>;
     dimensions: ZodEnum<{
        none: ...;
        own: ...;
     }>;
     maxDimension: ZodNullable<ZodNumber>;
     defaultWidth: ZodNumber;
     defaultHeight: ZodNumber;
     steps: ZodEnum<{
        steps: ...;
        num_steps: ...;
        fixed: ...;
     }>;
     maxSteps: ZodNullable<ZodNumber>;
     defaultSteps: ZodNullable<ZodNumber>;
     referenceField: ZodNullable<ZodString>;
     maxReferences: ZodNumber;
  }, $strict>>>;
  sizes: ZodNullable<ZodReadonly<ZodArray<ZodString>>>;
  video: ZodNullable<ZodLazy<ZodReadonly<ZodObject<{
     minSeconds: ZodNumber;
     maxSeconds: ZodNumber;
     defaultSeconds: ZodNumber;
     durations: ZodReadonly<...>;
     provider: ZodEnum<...>;
     formats: ZodReadonly<...>;
     defaultResolution: ZodEnum<...>;
     defaultAspectRatio: ZodEnum<...>;
     defaultGenerateAudio: ZodNullable<...>;
     referenceRoles: ZodReadonly<...>;
     maxReferenceImages: ZodNumber;
     referenceResolutions: ZodReadonly<...>;
     prices: ZodReadonly<...>;
  }, $strict>>>>;
}, $strict>>>>;

Bounded catalog decoded by the App media broker before host filtering.

destinationSchemaconstant

Section titled “destinationSchema”
Signature
const destinationSchema: ZodObject<
  {
    computerId: ZodString;
    path: ZodString;
  },
  $strict
>;

An absolute output path on the Computer admitted by the App host.

appMediaGenerationResultSchemaconstant

Section titled “appMediaGenerationResultSchema”
Signature
const appMediaGenerationResultSchema: ZodObject<
  {
    destination: ZodObject<
      {
        computerId: ZodString;
        path: ZodString;
      },
      $strict
    >;
    bytes: ZodNumber;
    costMilliunits: ZodNumber;
    format: ZodEnum<{
      png: "png";
      jpeg: "jpeg";
      gif: "gif";
      webp: "webp";
      mp4: "mp4";
    }>;
    height: ZodNumber;
    model: ZodString;
    width: ZodNumber;
  },
  $strict
>;

Completed App generation output, with its admitted Computer destination.

appMediaAdmissionErrorSchemaconstant

Section titled “appMediaAdmissionErrorSchema”
Signature
const appMediaAdmissionErrorSchema: ZodObject<
  {
    error: ZodEnum<{
      revoked: "revoked";
      not_granted: "not_granted";
      grantor_lost_authority: "grantor_lost_authority";
      unavailable: "unavailable";
    }>;
  },
  $strict
>;

Authority refusals emitted by Media admission before a host call.

appMediaBudgetRefusalSchemaconstant

Section titled “appMediaBudgetRefusalSchema”
Signature
const appMediaBudgetRefusalSchema: ZodLazy<
  ZodObject<
    {
      error: ZodLiteral<"attachment_budget_exceeded">;
      kind: ZodLiteral<"media">;
      retryAfterMs: ZodNumber;
    },
    $strict
  >
>;

Attachment budget refusal emitted by the Media reservation owner.

appMediaAdmissionRefusalSchemaconstant

Section titled “appMediaAdmissionRefusalSchema”
Signature
const appMediaAdmissionRefusalSchema: ZodUnion<
  readonly [
    ZodObject<
      {
        error: ZodEnum<{
          revoked: "revoked";
          not_granted: "not_granted";
          grantor_lost_authority: "grantor_lost_authority";
          unavailable: "unavailable";
        }>;
      },
      $strict
    >,
    ZodLazy<
      ZodObject<
        {
          error: ZodLiteral<"attachment_budget_exceeded">;
          kind: ZodLiteral<"media">;
          retryAfterMs: ZodNumber;
        },
        $strict
      >
    >,
  ]
>;

Existing Media admission refusals, without an admitted selector or callable.

appMediaBrokerErrorSchemaconstant

Section titled “appMediaBrokerErrorSchema”
Signature
const appMediaBrokerErrorSchema: ZodObject<
  {
    error: ZodEnum<{
      revoked: "revoked";
      not_granted: "not_granted";
      grantor_lost_authority: "grantor_lost_authority";
      unavailable: "unavailable";
      invalid: "invalid";
      too_large: "too_large";
    }>;
  },
  $strict
>;

Admission errors plus invalid/oversized inputs emitted directly by the broker.

agentAppMediaLibraryFailureSchemaconstant

Section titled “agentAppMediaLibraryFailureSchema”
Signature
const agentAppMediaLibraryFailureSchema: ZodLazy<
  ZodObject<
    {
      error: ZodLiteral<"library_unavailable">;
      message: ZodString;
    },
    $strict
  >
>;

Missing-library refusal decoded and returned by the App media broker.

appMediaBrokerFailureSchemaconstant

Section titled “appMediaBrokerFailureSchema”
Signature
const appMediaBrokerFailureSchema: ZodObject<{
  error: ZodEnum<{
     CAPABILITY_DENIED: "CAPABILITY_DENIED";
     INSUFFICIENT_CREDIT: "INSUFFICIENT_CREDIT";
     HOST_FAILURE: "HOST_FAILURE";
     INVALID_ARGUMENT: "INVALID_ARGUMENT";
     SAFETY_FILTER_REFUSED: "SAFETY_FILTER_REFUSED";
  }>;
  message: ZodString;
  stage: ZodEnum<{
     admission: "admission";
     generation-authorization: "generation-authorization";
     settings: "settings";
     estimate: "estimate";
     billing: "billing";
     operation: "operation";
     provider: "provider";
     normalization: "normalization";
     artifact: "artifact";
     destination-authorization: "destination-authorization";
     destination-write: "destination-write";
  }>;
  retryable: ZodBoolean;
  provider: ZodOptional<ZodPipe<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodTransform<
     | Readonly<{
     category:   | "InferenceUpstreamError"
        | "AiInternalError"
        | "TypeError"
        | "AbortError"
        | "TimeoutError"
        | "Error";
     code: number | null;
   }>
     | Readonly<{
     category: "result_download";
     status: number;
  }>, unknown>>>;
}, $strict>;

Broker projection of an HTTP failure: code becomes error and error becomes message.

appMediaRefusalSchemaconstant

Section titled “appMediaRefusalSchema”
Signature
const appMediaRefusalSchema: ZodUnion<readonly [ZodObject<{
  error: ZodEnum<{
     revoked: "revoked";
     not_granted: "not_granted";
     grantor_lost_authority: "grantor_lost_authority";
     unavailable: "unavailable";
     invalid: "invalid";
     too_large: "too_large";
  }>;
}, $strict>, ZodLazy<ZodObject<{
  error: ZodLiteral<"attachment_budget_exceeded">;
  kind: ZodLiteral<"media">;
  retryAfterMs: ZodNumber;
}, $strict>>, ZodLazy<ZodObject<{
  error: ZodLiteral<"library_unavailable">;
  message: ZodString;
}, $strict>>, ZodObject<{
  error: ZodEnum<{
     CAPABILITY_DENIED: "CAPABILITY_DENIED";
     INSUFFICIENT_CREDIT: "INSUFFICIENT_CREDIT";
     HOST_FAILURE: "HOST_FAILURE";
     INVALID_ARGUMENT: "INVALID_ARGUMENT";
     SAFETY_FILTER_REFUSED: "SAFETY_FILTER_REFUSED";
  }>;
  message: ZodString;
  stage: ZodEnum<{
     admission: "admission";
     generation-authorization: "generation-authorization";
     settings: "settings";
     estimate: "estimate";
     billing: "billing";
     operation: "operation";
     provider: "provider";
     normalization: "normalization";
     artifact: "artifact";
     destination-authorization: "destination-authorization";
     destination-write: "destination-write";
  }>;
  retryable: ZodBoolean;
  provider: ZodOptional<ZodPipe<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodTransform<
     | Readonly<{
     category: ... | ... | ... | ... | ... | ...;
     code: ... | ...;
   }>
     | Readonly<{
     category: "result_download";
     status: number;
  }>, unknown>>>;
}, $strict>]>;

Refusal payloads emitted by the App media broker, separate from transport errors.

appMediaModelsOutcomeSchemaconstant

Section titled “appMediaModelsOutcomeSchema”
Signature
const appMediaModelsOutcomeSchema: ZodUnion<readonly [ZodLazy<ZodArray<ZodReadonly<ZodObject<{
  id: ZodString;
  label: ZodString;
  kind: ZodEnum<{
     image: "image";
     video: "video";
  }>;
  tier: ZodEnum<{
     draft: "draft";
     balanced: "balanced";
     premium: "premium";
     max: "max";
  }>;
  outputFormats: ZodReadonly<ZodArray<ZodEnum<{
     png: ...;
     jpeg: ...;
     webp: ...;
  }>>>;
  maxPromptLength: ZodNumber;
  input: ZodLazy<ZodReadonly<ZodObject<{
     transport: ...;
     dimensions: ...;
     maxDimension: ...;
     defaultWidth: ...;
     defaultHeight: ...;
     steps: ...;
     maxSteps: ...;
     defaultSteps: ...;
     referenceField: ...;
     maxReferences: ...;
  }, $strict>>>;
  sizes: ZodNullable<ZodReadonly<ZodArray<ZodString>>>;
  video: ZodNullable<ZodLazy<ZodReadonly<ZodObject<..., ...>>>>;
}, $strict>>>>, ZodUnion<readonly [ZodObject<{
  error: ZodEnum<{
     revoked: "revoked";
     not_granted: "not_granted";
     grantor_lost_authority: "grantor_lost_authority";
     unavailable: "unavailable";
     invalid: "invalid";
     too_large: "too_large";
  }>;
}, $strict>, ZodLazy<ZodObject<{
  error: ZodLiteral<"attachment_budget_exceeded">;
  kind: ZodLiteral<"media">;
  retryAfterMs: ZodNumber;
}, $strict>>, ZodLazy<ZodObject<{
  error: ZodLiteral<"library_unavailable">;
  message: ZodString;
}, $strict>>, ZodObject<{
  error: ZodEnum<{
     CAPABILITY_DENIED: "CAPABILITY_DENIED";
     INSUFFICIENT_CREDIT: "INSUFFICIENT_CREDIT";
     HOST_FAILURE: "HOST_FAILURE";
     INVALID_ARGUMENT: "INVALID_ARGUMENT";
     SAFETY_FILTER_REFUSED: "SAFETY_FILTER_REFUSED";
  }>;
  message: ZodString;
  stage: ZodEnum<{
     admission: "admission";
     generation-authorization: "generation-authorization";
     settings: "settings";
     estimate: "estimate";
     billing: "billing";
     operation: "operation";
     provider: "provider";
     normalization: "normalization";
     artifact: "artifact";
     destination-authorization: "destination-authorization";
     destination-write: "destination-write";
  }>;
  retryable: ZodBoolean;
  provider: ZodOptional<ZodPipe<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodTransform<Readonly<...> | Readonly<...>, unknown>>>;
}, $strict>]>]>;

Model-list payload or an existing broker refusal.

appMediaGenerationOutcomeSchemaconstant

Section titled “appMediaGenerationOutcomeSchema”
Signature
const appMediaGenerationOutcomeSchema: ZodUnion<readonly [ZodObject<{
  destination: ZodObject<{
     computerId: ZodString;
     path: ZodString;
  }, $strict>;
  bytes: ZodNumber;
  costMilliunits: ZodNumber;
  format: ZodEnum<{
     png: "png";
     jpeg: "jpeg";
     gif: "gif";
     webp: "webp";
     mp4: "mp4";
  }>;
  height: ZodNumber;
  model: ZodString;
  width: ZodNumber;
}, $strict>, ZodObject<{
  kind: ZodLiteral<"pending">;
  retryAfterMs: ZodNumber;
}, $strict>, ZodUnion<readonly [ZodObject<{
  error: ZodEnum<{
     revoked: "revoked";
     not_granted: "not_granted";
     grantor_lost_authority: "grantor_lost_authority";
     unavailable: "unavailable";
     invalid: "invalid";
     too_large: "too_large";
  }>;
}, $strict>, ZodLazy<ZodObject<{
  error: ZodLiteral<"attachment_budget_exceeded">;
  kind: ZodLiteral<"media">;
  retryAfterMs: ZodNumber;
}, $strict>>, ZodLazy<ZodObject<{
  error: ZodLiteral<"library_unavailable">;
  message: ZodString;
}, $strict>>, ZodObject<{
  error: ZodEnum<{
     CAPABILITY_DENIED: "CAPABILITY_DENIED";
     INSUFFICIENT_CREDIT: "INSUFFICIENT_CREDIT";
     HOST_FAILURE: "HOST_FAILURE";
     INVALID_ARGUMENT: "INVALID_ARGUMENT";
     SAFETY_FILTER_REFUSED: "SAFETY_FILTER_REFUSED";
  }>;
  message: ZodString;
  stage: ZodEnum<{
     admission: "admission";
     generation-authorization: "generation-authorization";
     settings: "settings";
     estimate: "estimate";
     billing: "billing";
     operation: "operation";
     provider: "provider";
     normalization: "normalization";
     artifact: "artifact";
     destination-authorization: "destination-authorization";
     destination-write: "destination-write";
  }>;
  retryable: ZodBoolean;
  provider: ZodOptional<ZodPipe<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodTransform<Readonly<...> | Readonly<...>, unknown>>>;
}, $strict>]>]>;

Completed generation, Agar polling result, or an existing broker refusal.