diff --git a/components/admin/AdminTreeNavigation.tsx b/components/admin/AdminTreeNavigation.tsx
index aeb0c6b3..bd7d709d 100644
--- a/components/admin/AdminTreeNavigation.tsx
+++ b/components/admin/AdminTreeNavigation.tsx
@@ -58,6 +58,12 @@ export default function AdminTreeNavigation({
icon: HiOutlineCollection,
href: '/admin/add-unclaimed-node',
},
+ {
+ id: 'tag-management',
+ label: t('Tag Management'),
+ icon: HiOutlineCollection,
+ href: '/admin/tags',
+ },
],
},
{
diff --git a/locales/ar/common.json b/locales/ar/common.json
index 6c1f7e38..41191b9f 100644
--- a/locales/ar/common.json
+++ b/locales/ar/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "إضافة عقدة غير مُطالب بها",
"Admin Dashboard": "لوحة تحكم المشرف",
"Admin Navigation": "تنقل المسؤول",
+ "Admin Tags": "علامات المشرف",
+ "Admin Tags (comma separated)": "علامات المشرف (مفصولة بفواصل)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "علامات خاصة بالمسؤول لتحذيرات الأمان والبيانات الوصفية (مثل: dev، unsafe، fragile_deps)",
"All": "الكل",
"All Nodes": "جميع العقد",
"All Tags": "جميع العلامات",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "تحرير أسماء العقد المحجوزة لـ Comfy",
"Edit Publisher": "تحرير الناشر",
"Edit Search Ranking": "تحرير ترتيب البحث",
+ "Edit Tags": "تحرير العلامات",
"Edit details": "تحرير التفاصيل",
"Edit node": "تحرير العقدة",
"Edit secret key": "تحرير مفتاح السر",
+ "Edit tags": "تحرير العلامات",
"Edit unclaimed node": "تحرير عقدة غير مُطالب بها",
+ "Enter admin tags separated by commas": "أدخل علامات المشرف مفصولة بفواصل",
"Enter category": "أدخل فئة",
"Enter one OS per line": "أدخل نظام تشغيل واحد لكل سطر",
"Enter one accelerator per line": "أدخل مسرعًا واحدًا في كل سطر",
@@ -208,6 +214,7 @@
"Name": "اسم",
"New Publisher": "ناشر جديد",
"Next": "التالي",
+ "No admin tags": "لا توجد علامات مسؤول",
"No batch ID found for {{id}}@{{version}}": "لم يتم العثور على معرف دفعة لـ {{id}}@{{version}}",
"No nodes found": "لم يتم العثور على عقد",
"No preempted comfy node names added yet": "لم تتم إضافة أسماء عقد Comfy محجوزة بعد",
@@ -215,6 +222,7 @@
"No publishers found": "لم يتم العثور على ناشرين",
"No repository URL available for this node": "لا يوجد عنوان URL للمستودع مُتاح لهذه العقدة.",
"No status history found for {{id}}@{{version}}": "لم يتم العثور على تاريخ الحالة لـ {{id}}@{{version}}",
+ "No tags": "لا توجد علامات",
"No unclaimed nodes found.": "لم يتم العثور على عقد غير مُطالب بها.",
"No versions selected": "لم يتم اختيار أي إصدارات",
"Node": "عقدة",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "يلزم معرّف العقدة للمطالبة به.",
"Node Information": "معلومات العقدة",
"Node Management": "إدارة العقدة",
+ "Node Name": "اسم العقدة",
"Node Version": "إصدار العقدة",
"Node Version Compatibility": "توافق إصدار العقدة",
"Node Version Compatibility Admin": "توافق إصدار العقدة مسئول النظام",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "تمت المطالبة بالعقدة {{name}} بنجاح من قبل {{publisherName}}",
"Nodes": "عقد",
"Nodes List": "قائمة العقد",
+ "Nodes with Tags": "العقد مع العلامات",
"None": "لا شيء",
"Not specified": "غير محدد",
"Note": "ملاحظة",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "اضغط Ctrl+Enter للحفظ",
"Previous": "السابق",
"Processing verification result...": "جارٍ معالجة نتيجة التحقق...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "العلامات العامة المرئية لجميع المستخدمين (مثل الفيديو، الصوت، الأداة)",
"Publisher": "الناشر",
"Publisher ID": "معرف الناشر",
"Publisher ID in repository does not match selected publisher": "معرف الناشر في المستودع لا يتطابق مع الناشر المحدد",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "الخطوة 5: المطالبة ناجحة",
"Supported Accelerators": "المسرعات المدعومة",
"Supported Operating Systems": "أنظمة التشغيل المدعومة",
+ "Tag Management": "إدارة العلامات",
"Tags": "علامات",
"Tags (comma separated)": "علامات (مفصولة بفواصل)",
"There was an error loading the nodes. Please try again later.": "حدث خطأ أثناء تحميل العقد. يرجى المحاولة مرة أخرى لاحقًا.",
diff --git a/locales/en/common.json b/locales/en/common.json
index 054a2f57..4f8f74ec 100644
--- a/locales/en/common.json
+++ b/locales/en/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "Add unclaimed node",
"Admin Dashboard": "Admin Dashboard",
"Admin Navigation": "Admin Navigation",
+ "Admin Tags": "Admin Tags",
+ "Admin Tags (comma separated)": "Admin Tags (comma separated)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)",
"All": "All",
"All Nodes": "All Nodes",
"All Tags": "All Tags",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "Edit Preempted Comfy Node Names",
"Edit Publisher": "Edit Publisher",
"Edit Search Ranking": "Edit Search Ranking",
+ "Edit Tags": "Edit Tags",
"Edit details": "Edit details",
"Edit node": "Edit node",
"Edit secret key": "Edit secret key",
+ "Edit tags": "Edit tags",
"Edit unclaimed node": "Edit unclaimed node",
+ "Enter admin tags separated by commas": "Enter admin tags separated by commas",
"Enter category": "Enter category",
"Enter one OS per line": "Enter one OS per line",
"Enter one accelerator per line": "Enter one accelerator per line",
@@ -208,6 +214,7 @@
"Name": "Name",
"New Publisher": "New Publisher",
"Next": "Next",
+ "No admin tags": "No admin tags",
"No batch ID found for {{id}}@{{version}}": "No batch ID found for {{id}}@{{version}}",
"No nodes found": "No nodes found",
"No preempted comfy node names added yet": "No preempted comfy node names added yet",
@@ -215,6 +222,7 @@
"No publishers found": "No publishers found",
"No repository URL available for this node": "No repository URL available for this node",
"No status history found for {{id}}@{{version}}": "No status history found for {{id}}@{{version}}",
+ "No tags": "No tags",
"No unclaimed nodes found.": "No unclaimed nodes found.",
"No versions selected": "No versions selected",
"Node": "Node",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "Node ID is required for claiming.",
"Node Information": "Node Information",
"Node Management": "Node Management",
+ "Node Name": "Node Name",
"Node Version": "Node Version",
"Node Version Compatibility": "Node Version Compatibility",
"Node Version Compatibility Admin": "Node Version Compatibility Admin",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "Node {{name}} successfully claimed by {{publisherName}}",
"Nodes": "Nodes",
"Nodes List": "Nodes List",
+ "Nodes with Tags": "Nodes with Tags",
"None": "None",
"Not specified": "Not specified",
"Note": "Note",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Press Ctrl+Enter to save",
"Previous": "Previous",
"Processing verification result...": "Processing verification result...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "Public tags visible to all users (e.g., video, audio, utility)",
"Publisher": "Publisher",
"Publisher ID": "Publisher ID",
"Publisher ID in repository does not match selected publisher": "Publisher ID in repository does not match selected publisher",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "Step 5: Claim Successful",
"Supported Accelerators": "Supported Accelerators",
"Supported Operating Systems": "Supported Operating Systems",
+ "Tag Management": "Tag Management",
"Tags": "Tags",
"Tags (comma separated)": "Tags (comma separated)",
"There was an error loading the nodes. Please try again later.": "There was an error loading the nodes. Please try again later.",
diff --git a/locales/es/common.json b/locales/es/common.json
index ec8f0fbe..ad92d73b 100644
--- a/locales/es/common.json
+++ b/locales/es/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "Agregar nodo no reclamado",
"Admin Dashboard": "Tablero de Administrador",
"Admin Navigation": "Navegación de administrador",
+ "Admin Tags": "Etiquetas de administrador",
+ "Admin Tags (comma separated)": "Etiquetas de administrador (separadas por comas)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "Etiquetas solo para administradores para advertencias de seguridad y metadatos (por ejemplo, dev, unsafe, fragile_deps)",
"All": "Todos",
"All Nodes": "Todos los Nodos",
"All Tags": "Todas las Etiquetas",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "Editar los nombres de nodo Comfy anticipados",
"Edit Publisher": "Editar Editor",
"Edit Search Ranking": "Editar Clasificación de Búsqueda",
+ "Edit Tags": "Editar Etiquetas",
"Edit details": "Editar detalles",
"Edit node": "Editar nodo",
"Edit secret key": "Editar clave secreta",
+ "Edit tags": "Editar etiquetas",
"Edit unclaimed node": "Editar nodo no reclamado",
+ "Enter admin tags separated by commas": "Ingrese etiquetas de administrador separadas por comas",
"Enter category": "Ingrese categoría",
"Enter one OS per line": "Ingrese un sistema operativo por línea",
"Enter one accelerator per line": "Ingrese un acelerador por línea",
@@ -208,6 +214,7 @@
"Name": "Nombre",
"New Publisher": "Nuevo Editor",
"Next": "Siguiente",
+ "No admin tags": "No hay etiquetas de administrador",
"No batch ID found for {{id}}@{{version}}": "No se encontró ID de lote para {{id}}@{{version}}",
"No nodes found": "No se encontraron nodos",
"No preempted comfy node names added yet": "Aún no se han agregado nombres de nodos cómodos anticipados",
@@ -215,6 +222,7 @@
"No publishers found": "No se encontraron editores",
"No repository URL available for this node": "No hay URL de repositorio disponible para este nodo",
"No status history found for {{id}}@{{version}}": "No se encontró el historial de estado para {{id}}@{{version}}",
+ "No tags": "Sin etiquetas",
"No unclaimed nodes found.": "No se encontraron nodos sin reclamar.",
"No versions selected": "No se han seleccionado versiones",
"Node": "Nodo",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "需要节点ID进行认领。",
"Node Information": "Información del Nodo",
"Node Management": "Gestión de Nodos",
+ "Node Name": "Nombre del nodo",
"Node Version": "Versión de Nodo",
"Node Version Compatibility": "Compatibilidad de Versión de Nodo",
"Node Version Compatibility Admin": "Administrador de Compatibilidad de Versión de Nodo",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "Nodo {{name}} reclamado exitosamente por {{publisherName}}",
"Nodes": "Nodos",
"Nodes List": "Lista de Nodos",
+ "Nodes with Tags": "Nodos con etiquetas",
"None": "Ninguno",
"Not specified": "No especificado",
"Note": "Nota",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Presiona Ctrl+Enter para guardar",
"Previous": "Anterior",
"Processing verification result...": "Procesando el resultado de la verificación...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "Etiquetas públicas visibles para todos los usuarios (por ejemplo, video, audio, utilidad)",
"Publisher": "Editor",
"Publisher ID": "ID del editor",
"Publisher ID in repository does not match selected publisher": "El ID del editor en el repositorio no coincide con el editor seleccionado.",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "Paso 5: Reclamo exitoso",
"Supported Accelerators": "Aceleradores compatibles",
"Supported Operating Systems": "Sistemas Operativos Compatibles",
+ "Tag Management": "Gestión de Etiquetas",
"Tags": "Etiquetas",
"Tags (comma separated)": "Etiquetas (separadas por comas)",
"There was an error loading the nodes. Please try again later.": "Hubo un error al cargar los nodos. Por favor, inténtelo de nuevo más tarde.",
diff --git a/locales/fr/common.json b/locales/fr/common.json
index ac3f8dd2..650a13e3 100644
--- a/locales/fr/common.json
+++ b/locales/fr/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "Ajouter un nœud non réclamé",
"Admin Dashboard": "Tableau de bord de l'administrateur",
"Admin Navigation": "Admin Navigation",
+ "Admin Tags": "Admin Tags",
+ "Admin Tags (comma separated)": "Admin Tags (séparés par des virgules)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "Tags réservés aux administrateurs pour les avertissements de sécurité et les métadonnées (par exemple, dev, unsafe, fragile_deps)",
"All": "Tous",
"All Nodes": "Tous les nœuds",
"All Tags": "Tous les tags",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "Modifier les noms de noeuds Comfy préemptés",
"Edit Publisher": "Modifier l'éditeur",
"Edit Search Ranking": "Modifier le classement de recherche",
+ "Edit Tags": "Éditer les tags",
"Edit details": "Modifier les détails",
"Edit node": "Modifier le nœud",
"Edit secret key": "Modifier la clé secrète",
+ "Edit tags": "Éditer les tags",
"Edit unclaimed node": "Modifier le nœud non réclamé",
+ "Enter admin tags separated by commas": "Entrez les tags administrateur séparés par des virgules",
"Enter category": "Entrez la catégorie",
"Enter one OS per line": "Entrez un système d'exploitation par ligne",
"Enter one accelerator per line": "Entrez un accélérateur par ligne",
@@ -208,6 +214,7 @@
"Name": "Nom",
"New Publisher": "Nouvel Éditeur",
"Next": "Suivant",
+ "No admin tags": "Pas de tags d'administrateur",
"No batch ID found for {{id}}@{{version}}": "Aucun ID de lot trouvé pour {{id}}@{{version}}",
"No nodes found": "Aucun nœud trouvé",
"No preempted comfy node names added yet": "Aucun nom de nœud confort préempté n'a encore été ajouté",
@@ -215,6 +222,7 @@
"No publishers found": "Aucun éditeur trouvé",
"No repository URL available for this node": "Aucune URL de dépôt disponible pour ce nœud",
"No status history found for {{id}}@{{version}}": "Aucun historique de statut trouvé pour {{id}}@{{version}}",
+ "No tags": "Pas de tags",
"No unclaimed nodes found.": "Aucun nœud non réclamé trouvé.",
"No versions selected": "Aucune version sélectionnée",
"Node": "Nœud",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "L'ID de nœud est requis pour la revendication.",
"Node Information": "Informations sur le nœud",
"Node Management": "Gestion des nœuds",
+ "Node Name": "Nom du nœud",
"Node Version": "Version de nœud",
"Node Version Compatibility": "Compatibilité de la version du nœud",
"Node Version Compatibility Admin": "Administrateur de Compatibilité de Version de Nœud",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "Noeud {{name}} revendiqué avec succès par {{publisherName}}",
"Nodes": "Nœuds",
"Nodes List": "Liste des nœuds",
+ "Nodes with Tags": "Nœuds avec tags",
"None": "Aucun",
"Not specified": "Non spécifié",
"Note": "Note",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Appuyez sur Ctrl+Entrée pour enregistrer",
"Previous": "Précédent",
"Processing verification result...": "Traitement du résultat de la vérification...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "Tags publics visibles par tous les utilisateurs (par exemple, vidéo, audio, utilitaire)",
"Publisher": "Éditeur",
"Publisher ID": "ID de l'éditeur",
"Publisher ID in repository does not match selected publisher": "L'ID de l'éditeur dans le dépôt ne correspond pas à l'éditeur sélectionné.",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "Étape 5 : Revendication réussie",
"Supported Accelerators": "Accélérateurs pris en charge",
"Supported Operating Systems": "Systèmes d'exploitation pris en charge",
+ "Tag Management": "Gestion des tags",
"Tags": "Tags",
"Tags (comma separated)": "Tags (séparés par des virgules)",
"There was an error loading the nodes. Please try again later.": "Il y a eu une erreur lors du chargement des nœuds. Veuillez réessayer plus tard.",
diff --git a/locales/ja/common.json b/locales/ja/common.json
index f6d5b555..07619f9a 100644
--- a/locales/ja/common.json
+++ b/locales/ja/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "未請求ノードを追加",
"Admin Dashboard": "管理ダッシュボード",
"Admin Navigation": "管理者ナビゲーション",
+ "Admin Tags": "管理者タグ",
+ "Admin Tags (comma separated)": "管理者タグ(カンマ区切り)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "管理者のみが使用できるセキュリティ警告やメタデータのタグ(例: dev, unsafe, fragile_deps)",
"All": "すべて",
"All Nodes": "すべてのノード",
"All Tags": "すべてのタグ",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "先取りされたComfyノード名を編集",
"Edit Publisher": "パブリッシャーを編集",
"Edit Search Ranking": "検索ランキングを編集",
+ "Edit Tags": "タグを編集",
"Edit details": "詳細を編集",
"Edit node": "ノードを編集",
"Edit secret key": "秘密鍵を編集",
+ "Edit tags": "タグを編集",
"Edit unclaimed node": "未請求ノードを編集",
+ "Enter admin tags separated by commas": "管理者タグを入力(カンマ区切り)",
"Enter category": "カテゴリーを入力",
"Enter one OS per line": "1行につき1つのOSを入力してください",
"Enter one accelerator per line": "1行につき1つの加速器を入力してください",
@@ -208,6 +214,7 @@
"Name": "名前",
"New Publisher": "新しいパブリッシャー",
"Next": "次へ",
+ "No admin tags": "管理者タグなし",
"No batch ID found for {{id}}@{{version}}": "{{id}}@{{version}}のバッチIDが見つかりません",
"No nodes found": "ノードが見つかりません",
"No preempted comfy node names added yet": "まだ先取りされたComfyノード名は追加されていません",
@@ -215,6 +222,7 @@
"No publishers found": "パブリッシャーが見つかりませんでした。",
"No repository URL available for this node": "このノードにはリポジトリURLが利用できません。",
"No status history found for {{id}}@{{version}}": "{{id}}@{{version}}のステータス履歴が見つかりませんでした",
+ "No tags": "タグなし",
"No unclaimed nodes found.": "未請求のノードは見つかりませんでした。",
"No versions selected": "バージョンが選択されていません",
"Node": "ノード",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "請求するためにはノードIDが必要です。",
"Node Information": "ノード情報",
"Node Management": "ノード管理",
+ "Node Name": "ノード名",
"Node Version": "ノードバージョン",
"Node Version Compatibility": "ノードバージョンの互換性",
"Node Version Compatibility Admin": "ノードバージョン互換性管理者",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "ノード{{name}}が{{publisherName}}によって成功裏に要求されました。",
"Nodes": "ノード",
"Nodes List": "ノード一覧",
+ "Nodes with Tags": "タグ付きノード",
"None": "なし",
"Not specified": "未指定",
"Note": "ノート",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Ctrl+Enter を押して保存",
"Previous": "前へ",
"Processing verification result...": "確認結果の処理中...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "すべてのユーザーに表示される公開タグ(例:ビデオ、音声、ユーティリティ)",
"Publisher": "パブリッシャー",
"Publisher ID": "パブリッシャーID",
"Publisher ID in repository does not match selected publisher": "リポジトリ内のパブリッシャーIDが選択したパブリッシャーと一致しません",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "ステップ5:請求成功",
"Supported Accelerators": "サポートされている加速器",
"Supported Operating Systems": "サポートされているオペレーティングシステム",
+ "Tag Management": "タグ管理",
"Tags": "タグ",
"Tags (comma separated)": "タグ(カンマ区切り)",
"There was an error loading the nodes. Please try again later.": "ノードの読み込み中にエラーが発生しました。後でもう一度お試しください。",
diff --git a/locales/ko/common.json b/locales/ko/common.json
index 434d8efd..eeb40aa6 100644
--- a/locales/ko/common.json
+++ b/locales/ko/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "미청구 노드 추가",
"Admin Dashboard": "관리자 대시보드",
"Admin Navigation": "관리자 탐색",
+ "Admin Tags": "관리자 태그",
+ "Admin Tags (comma separated)": "관리자 태그 (쉼표로 구분)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "보안 경고 및 메타데이터를 위한 관리자 전용 태그(예: dev, unsafe, fragile_deps)",
"All": "모두",
"All Nodes": "모든 노드",
"All Tags": "모든 태그",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "사전 점유된 Comfy 노드 이름 수정",
"Edit Publisher": "발행인 수정",
"Edit Search Ranking": "검색 순위 수정",
+ "Edit Tags": "태그 편집",
"Edit details": "세부 정보 수정",
"Edit node": "노드 편집",
"Edit secret key": "비밀 키 수정",
+ "Edit tags": "태그 편집",
"Edit unclaimed node": "미청구 노드 편집",
+ "Enter admin tags separated by commas": "관리자 태그를 쉼표로 구분하여 입력하세요",
"Enter category": "카테고리 입력",
"Enter one OS per line": "한 줄에 하나의 운영 체제를 입력하세요.",
"Enter one accelerator per line": "한 줄에 하나의 가속기를 입력하세요.",
@@ -208,6 +214,7 @@
"Name": "이름",
"New Publisher": "새로운 발행인",
"Next": "다음",
+ "No admin tags": "관리자 태그 없음",
"No batch ID found for {{id}}@{{version}}": "{{id}}@{{version}}에 대한 배치 ID를 찾을 수 없습니다",
"No nodes found": "노드를 찾을 수 없습니다",
"No preempted comfy node names added yet": "아직 사전 점유된 Comfy 노드 이름이 추가되지 않았습니다.",
@@ -215,6 +222,7 @@
"No publishers found": "발행인을 찾을 수 없습니다",
"No repository URL available for this node": "이 노드에 대한 저장소 URL이 없습니다",
"No status history found for {{id}}@{{version}}": "{{id}}@{{version}}에 대한 상태 기록을 찾을 수 없습니다",
+ "No tags": "태그 없음",
"No unclaimed nodes found.": "미청구 노드를 찾을 수 없습니다.",
"No versions selected": "버전이 선택되지 않았습니다.",
"Node": "노드",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "노드를 청구하려면 노드 ID가 필요합니다.",
"Node Information": "노드 정보",
"Node Management": "노드 관리",
+ "Node Name": "노드 이름",
"Node Version": "노드 버전",
"Node Version Compatibility": "노드 버전 호환성",
"Node Version Compatibility Admin": "노드 버전 호환성 관리자",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "{{publisherName}}에 의해 노드 {{name}}이(가) 성공적으로 인수되었습니다",
"Nodes": "노드",
"Nodes List": "노드 목록",
+ "Nodes with Tags": "태그가 있는 노드",
"None": "없음",
"Not specified": "지정되지 않음",
"Note": "노트",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Ctrl+Enter를 눌러 저장",
"Previous": "이전",
"Processing verification result...": "검증 결과 처리 중...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "모든 사용자에게 보이는 공용 태그 (예: 비디오, 오디오, 유틸리티)",
"Publisher": "발행인",
"Publisher ID": "발행인 ID",
"Publisher ID in repository does not match selected publisher": "저장소의 발행인 ID가 선택한 발행인과 일치하지 않습니다.",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "단계 5: 청구 성공",
"Supported Accelerators": "지원되는 가속기",
"Supported Operating Systems": "지원되는 운영 체제",
+ "Tag Management": "태그 관리",
"Tags": "태그",
"Tags (comma separated)": "태그 (쉼표로 구분)",
"There was an error loading the nodes. Please try again later.": "노드를 로드하는 중 오류가 발생했습니다. 나중에 다시 시도하십시오.",
diff --git a/locales/ru/common.json b/locales/ru/common.json
index 47fa10fb..44535f85 100644
--- a/locales/ru/common.json
+++ b/locales/ru/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "Добавить невостребованный узел",
"Admin Dashboard": "Панель администратора",
"Admin Navigation": "Административная навигация",
+ "Admin Tags": "Админ теги",
+ "Admin Tags (comma separated)": "Админ теги (через запятую)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "Теги, доступные только администраторам, для предупреждений о безопасности и метаданных (например, dev, unsafe, fragile_deps)",
"All": "Все",
"All Nodes": "Все узлы",
"All Tags": "Все теги",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "Редактировать замещенные имена узлов Comfy",
"Edit Publisher": "Редактировать издателя",
"Edit Search Ranking": "Редактировать рейтинг поиска",
+ "Edit Tags": "Редактировать теги",
"Edit details": "Редактировать детали",
"Edit node": "Редактировать узел",
"Edit secret key": "Редактировать секретный ключ",
+ "Edit tags": "Редактировать теги",
"Edit unclaimed node": "Редактировать невостребованный узел",
+ "Enter admin tags separated by commas": "Введите админ теги, разделенные запятыми",
"Enter category": "Введите категорию",
"Enter one OS per line": "Введите одну операционную систему на каждую строку",
"Enter one accelerator per line": "Введите один ускоритель на каждую строку",
@@ -208,6 +214,7 @@
"Name": "Имя",
"New Publisher": "Новый издатель",
"Next": "Следующий",
+ "No admin tags": "Нет админ тегов",
"No batch ID found for {{id}}@{{version}}": "Не найден batch ID для {{id}}@{{version}}",
"No nodes found": "Узлы не найдены",
"No preempted comfy node names added yet": "Замещенные имена узлов comfy еще не добавлены",
@@ -215,6 +222,7 @@
"No publishers found": "Издатели не найдены",
"No repository URL available for this node": "URL репозитория недоступен для этого узла",
"No status history found for {{id}}@{{version}}": "История статуса не найдена для {{id}}@{{version}}",
+ "No tags": "Нет тегов",
"No unclaimed nodes found.": "Невостребованные узлы не найдены.",
"No versions selected": "Версии не выбраны",
"Node": "Узел",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "Для заявки требуется ID узла.",
"Node Information": "Информация об узле",
"Node Management": "Управление узлами",
+ "Node Name": "Имя узла",
"Node Version": "Версия узла",
"Node Version Compatibility": "Совместимость версий узла",
"Node Version Compatibility Admin": "Администратор совместимости версий узла",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "Узел {{name}} успешно заявлен {{publisherName}}",
"Nodes": "Узлы",
"Nodes List": "Список узлов",
+ "Nodes with Tags": "Узлы с тегами",
"None": "Нет",
"Not specified": "Не указано",
"Note": "Примечание",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Нажмите Ctrl+Enter, чтобы сохранить",
"Previous": "Предыдущий",
"Processing verification result...": "Обработка результата проверки...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "Публичные теги, видимые всем пользователям (например, видео, аудио, утилита)",
"Publisher": "Издатель",
"Publisher ID": "ID издателя",
"Publisher ID in repository does not match selected publisher": "ID издателя в репозитории не совпадает с выбранным издателем",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "Шаг 5: Заявка успешна",
"Supported Accelerators": "Поддерживаемые ускорители",
"Supported Operating Systems": "Поддерживаемые операционные системы",
+ "Tag Management": "Управление тегами",
"Tags": "Теги",
"Tags (comma separated)": "Теги (через запятую)",
"There was an error loading the nodes. Please try again later.": "Произошла ошибка при загрузке узлов. Пожалуйста, попробуйте позже.",
diff --git a/locales/tr/common.json b/locales/tr/common.json
index 315aac29..69994c60 100644
--- a/locales/tr/common.json
+++ b/locales/tr/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "Sahipsiz Düğüm Ekle",
"Admin Dashboard": "Yönetici Kontrol Paneli",
"Admin Navigation": "Yönetici Gezinme",
+ "Admin Tags": "Yönetici Etiketleri",
+ "Admin Tags (comma separated)": "Yönetici Etiketleri (virgülle ayrılmış)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "Yalnızca yöneticilere özel etiketler, güvenlik uyarıları ve meta veriler için (örn., dev, unsafe, fragile_deps)",
"All": "Tümü",
"All Nodes": "Tüm Düğümler",
"All Tags": "Tüm Etiketler",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "Öncelikli Comfy Düğüm İsimlerini Düzenle",
"Edit Publisher": "Yayıncıyı Düzenle",
"Edit Search Ranking": "Arama Sıralamasını Düzenle",
+ "Edit Tags": "Etiketleri Düzenle",
"Edit details": "Ayrıntıları düzenle",
"Edit node": "Düğümü Düzenle",
"Edit secret key": "Gizli anahtarı düzenle",
+ "Edit tags": "Etiketleri düzenle",
"Edit unclaimed node": "Sahipsiz düğümü düzenle",
+ "Enter admin tags separated by commas": "Yönetici etiketlerini virgülle ayırarak girin",
"Enter category": "Kategori girin",
"Enter one OS per line": "Her satıra bir İS girin",
"Enter one accelerator per line": "Her satıra bir hızlandırıcı girin",
@@ -208,6 +214,7 @@
"Name": "Ad",
"New Publisher": "Yeni Yayıncı",
"Next": "Sonraki",
+ "No admin tags": "Yönetici etiketi yok",
"No batch ID found for {{id}}@{{version}}": "{{id}}@{{version}} için toplu işlem ID'si bulunamadı",
"No nodes found": "Düğüm bulunamadı",
"No preempted comfy node names added yet": "Henüz öncelikli Comfy düğüm isimleri eklenmedi",
@@ -215,6 +222,7 @@
"No publishers found": "Yayıncı bulunamadı",
"No repository URL available for this node": "Bu düğüm için kullanılabilir bir depo URL'si yok.",
"No status history found for {{id}}@{{version}}": "{{id}}@{{version}} için durum geçmişi bulunamadı",
+ "No tags": "Etiket yok",
"No unclaimed nodes found.": "Sahipsiz düğüm bulunamadı.",
"No versions selected": "Sürüm seçilmedi",
"Node": "Düğüm",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "Sahiplenme için Düğüm Kimliği gereklidir.",
"Node Information": "Düğüm Bilgisi",
"Node Management": "Düğüm Yönetimi",
+ "Node Name": "Düğüm Adı",
"Node Version": "Düğüm Sürümü",
"Node Version Compatibility": "Düğüm Sürüm Uyumluluğu",
"Node Version Compatibility Admin": "Düğüm Sürüm Uyumluluğu Yönetici",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "Düğüm {{name}}, {{publisherName}} tarafından başarıyla sahiplenildi.",
"Nodes": "Düğümler",
"Nodes List": "Düğüm Listesi",
+ "Nodes with Tags": "Etiketli Düğümler",
"None": "Hiçbiri",
"Not specified": "Belirtilmemiş",
"Note": "Not",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "Kaydetmek için Ctrl+Enter tuşlarına basın",
"Previous": "Önceki",
"Processing verification result...": "Doğrulama sonucu işleniyor...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "Tüm kullanıcılar tarafından görülebilen genel etiketler (örn., video, ses, yardımcı program)",
"Publisher": "Yayıncı",
"Publisher ID": "Yayıncı Kimliği",
"Publisher ID in repository does not match selected publisher": "Depodaki Yayıncı Kimliği, seçilen yayıncıyla eşleşmiyor.",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "Adım 5: Sahiplenme Başarılı",
"Supported Accelerators": "Desteklenen Hızlandırıcılar",
"Supported Operating Systems": "Desteklenen İşletim Sistemleri",
+ "Tag Management": "Etiket Yönetimi",
"Tags": "Etiketler",
"Tags (comma separated)": "Etiketler (virgülle ayrılmış)",
"There was an error loading the nodes. Please try again later.": "Düğümler yüklenirken bir hata oluştu. Lütfen daha sonra tekrar deneyin.",
diff --git a/locales/zh/common.json b/locales/zh/common.json
index ed78e239..d2298c83 100644
--- a/locales/zh/common.json
+++ b/locales/zh/common.json
@@ -13,6 +13,9 @@
"Add unclaimed node": "添加未认领节点",
"Admin Dashboard": "管理员仪表板",
"Admin Navigation": "管理员导航",
+ "Admin Tags": "管理员标签",
+ "Admin Tags (comma separated)": "管理员标签(逗号分隔)",
+ "Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)": "仅管理员可用的标签,用于安全警告和元数据(例如:dev,unsafe,fragile_deps)",
"All": "所有",
"All Nodes": "所有节点",
"All Tags": "所有标签",
@@ -120,10 +123,13 @@
"Edit Preempted Comfy Node Names": "编辑预占Comfy节点名称",
"Edit Publisher": "编辑发布者",
"Edit Search Ranking": "编辑搜索排名",
+ "Edit Tags": "编辑标签",
"Edit details": "编辑详情",
"Edit node": "编辑节点",
"Edit secret key": "编辑密钥",
+ "Edit tags": "编辑标签",
"Edit unclaimed node": "编辑未认领节点",
+ "Enter admin tags separated by commas": "输入管理员标签,以逗号分隔",
"Enter category": "输入类别",
"Enter one OS per line": "每行输入一个操作系统",
"Enter one accelerator per line": "每行输入一个加速器",
@@ -208,6 +214,7 @@
"Name": "名称",
"New Publisher": "新发布者",
"Next": "下一步",
+ "No admin tags": "没有管理员标签",
"No batch ID found for {{id}}@{{version}}": "未找到{{id}}@{{version}}的批次ID",
"No nodes found": "未找到节点",
"No preempted comfy node names added yet": "还没有添加预占的 Comfy 节点名称",
@@ -215,6 +222,7 @@
"No publishers found": "未找到发布者",
"No repository URL available for this node": "此节点没有可用的仓库 URL。",
"No status history found for {{id}}@{{version}}": "未找到 {{id}}@{{version}} 的状态历史",
+ "No tags": "无标签",
"No unclaimed nodes found.": "未找到未认领的节点。",
"No versions selected": "未选择版本",
"Node": "节点",
@@ -224,6 +232,7 @@
"Node ID is required for claiming.": "需要节点ID进行认领。",
"Node Information": "节点信息",
"Node Management": "节点管理",
+ "Node Name": "节点名称",
"Node Version": "节点版本",
"Node Version Compatibility": "节点版本兼容性",
"Node Version Compatibility Admin": "节点版本兼容性管理员",
@@ -241,6 +250,7 @@
"Node {{name}} successfully claimed by {{publisherName}}": "节点 {{name}} 成功被 {{publisherName}} 认领",
"Nodes": "节点",
"Nodes List": "节点列表",
+ "Nodes with Tags": "带有标签的节点",
"None": "无",
"Not specified": "未指定",
"Note": "注意",
@@ -266,6 +276,7 @@
"Press Ctrl+Enter to save": "按 Ctrl+Enter 保存",
"Previous": "上一步",
"Processing verification result...": "正在处理验证结果...",
+ "Public tags visible to all users (e.g., video, audio, utility)": "所有用户可见的公共标签(例如:视频,音频,实用工具)",
"Publisher": "发布者",
"Publisher ID": "发布者ID",
"Publisher ID in repository does not match selected publisher": "仓库中的发布者 ID 与所选发布者不匹配",
@@ -329,6 +340,7 @@
"Step 5: Claim Successful": "步骤5:认领成功",
"Supported Accelerators": "支持的加速器",
"Supported Operating Systems": "支持的操作系统",
+ "Tag Management": "标签管理",
"Tags": "标签",
"Tags (comma separated)": "标签(用逗号分隔)",
"There was an error loading the nodes. Please try again later.": "加载节点时出现错误。请稍后再试。",
diff --git a/pages/admin/index.tsx b/pages/admin/index.tsx
index abc651c2..f0c5b73a 100644
--- a/pages/admin/index.tsx
+++ b/pages/admin/index.tsx
@@ -32,7 +32,6 @@ function AdminDashboard() {
{t('Admin Dashboard')}
-
@@ -72,6 +71,13 @@ function AdminDashboard() {
{t('Manage All Nodes')}
+
+
+
{t('Tag Management')}
+
diff --git a/pages/admin/tags.tsx b/pages/admin/tags.tsx
new file mode 100644
index 00000000..a6297cd2
--- /dev/null
+++ b/pages/admin/tags.tsx
@@ -0,0 +1,418 @@
+import { useQueryClient } from '@tanstack/react-query'
+import {
+ Badge,
+ Breadcrumb,
+ Button,
+ Card,
+ Label,
+ Modal,
+ Spinner,
+ Table,
+ TextInput,
+} from 'flowbite-react'
+import { useRouter } from 'next/router'
+import { omit } from 'rambda'
+import React, { useState } from 'react'
+import { HiHome, HiOutlineCollection, HiPencil, HiTag } from 'react-icons/hi'
+import { toast } from 'react-toastify'
+import AdminTreeNavigation from '@/components/admin/AdminTreeNavigation'
+import { CustomPagination } from '@/components/common/CustomPagination'
+import withAdmin from '@/components/common/HOC/authAdmin'
+import { usePage } from '@/components/hooks/usePage'
+import { Node, useListAllNodes, useUpdateNode } from '@/src/api/generated'
+import { useNextTranslation } from '@/src/hooks/i18n'
+
+export default withAdmin(CategoriesPage)
+function CategoriesPage() {
+ const { t } = useNextTranslation()
+ const router = useRouter()
+ const [page, setPage] = usePage()
+ const [limit] = useState(20)
+ const [editingNode, setEditingNode] = useState(null)
+ const [editFormData, setEditFormData] = useState({
+ tags: '',
+ tags_admin: '',
+ })
+ const queryClient = useQueryClient()
+ const updateNodeMutation = useUpdateNode()
+
+ // Search filter
+ const queryForNodeId = Array.isArray(router.query.nodeId)
+ ? router.query.nodeId[0]
+ : router.query.nodeId
+
+ const { data: nodesData } = useListAllNodes({
+ page: page || 1,
+ limit: limit,
+ sort: ['name'],
+ })
+
+ const totalPages = Math.ceil((nodesData?.total || 0) / limit)
+
+ // Filter nodes by nodeId search
+ const nodes = React.useMemo(() => {
+ let filteredNodes = nodesData?.nodes || []
+
+ if (queryForNodeId) {
+ filteredNodes = filteredNodes.filter(
+ (node) =>
+ node.id
+ ?.toLowerCase()
+ .includes(queryForNodeId.toLowerCase()) ||
+ node.name
+ ?.toLowerCase()
+ .includes(queryForNodeId.toLowerCase())
+ )
+ }
+
+ return filteredNodes
+ }, [nodesData?.nodes, queryForNodeId])
+
+ const openEditModal = (node: Node) => {
+ setEditingNode(node)
+ setEditFormData({
+ tags: node.tags?.join(', ') || '',
+ tags_admin: node.tags_admin?.join(', ') || '',
+ })
+ }
+
+ const closeEditModal = () => {
+ setEditingNode(null)
+ setEditFormData({ tags: '', tags_admin: '' })
+ }
+
+ const handleSave = async () => {
+ if (!editingNode || !editingNode.publisher?.id) {
+ toast.error(
+ t('Unable to save: missing node or publisher information')
+ )
+ return
+ }
+
+ const updatedNode: Node = {
+ ...editingNode,
+ tags: editFormData.tags
+ .split(',')
+ .map((tag) => tag.trim())
+ .filter((tag) => tag.length > 0),
+ tags_admin: editFormData.tags_admin
+ .split(',')
+ .map((tag) => tag.trim())
+ .filter((tag) => tag.length > 0),
+ }
+
+ try {
+ await updateNodeMutation.mutateAsync({
+ publisherId: editingNode.publisher.id,
+ nodeId: editingNode.id!,
+ data: updatedNode,
+ })
+
+ toast.success(t('Node updated successfully'))
+ closeEditModal()
+ queryClient.invalidateQueries({ queryKey: ['/nodes'] })
+ } catch (error) {
+ console.error('Error updating node:', error)
+ toast.error(t('Error updating node'))
+ }
+ }
+
+ const handleKeyDown = (e: React.KeyboardEvent) => {
+ if (e.ctrlKey && e.key === 'Enter') {
+ e.preventDefault()
+ handleSave()
+ }
+ }
+
+ return (
+
+
+
+ {t('Home')}
+
+
+ {t('Admin Dashboard')}
+
+
+ {t('Tag Management')}
+
+
+
+
+ {t('Tag Management')}
+
+
+ {/* Search Filter */}
+
+
+
+
+
+
+
+
+
+ {t('Nodes with Tags')}
+
+
+ {nodesData?.total || 0} {t('nodes')}
+
+
+
+ {nodes.length > 0 ? (
+
+
+
+
+ {t('Node Name')}
+
+
+ {t('Tags')}
+
+
+ {t('Admin Tags')}
+
+
+ {t('Actions')}
+
+
+
+ {nodes.map((node) => (
+
+
+
+
+
+
+ {node.name}
+
+
+ @{node.id}
+
+
+
+
+
+
+ {node.tags &&
+ node.tags.length > 0 ? (
+ node.tags.map(
+ (tag) => (
+
+ {tag}
+
+ )
+ )
+ ) : (
+
+ {t('No tags')}
+
+ )}
+
+
+
+
+ {node.tags_admin &&
+ node.tags_admin.length >
+ 0 ? (
+ node.tags_admin.map(
+ (tag) => (
+
+ {tag}
+
+ )
+ )
+ ) : (
+
+ {t(
+ 'No admin tags'
+ )}
+
+ )}
+
+
+
+
+ openEditModal(node)
+ }
+ disabled={
+ !node.publisher?.id
+ }
+ title={
+ !node.publisher?.id
+ ? t(
+ 'No publisher information available'
+ )
+ : t('Edit tags')
+ }
+ >
+
+
+
+
+ ))}
+
+
+
+ ) : (
+
+
+
+ {t('No nodes found')}
+
+
+ )}
+
+ {totalPages > 1 && (
+
+
+
+ )}
+
+
+
+
+ {/* Edit Modal */}
+
+
+ {t('Edit Tags')}: {editingNode?.name}
+
+
+
+
+
+ {t('Tags (comma separated)')}
+
+
+ setEditFormData((prev) => ({
+ ...prev,
+ tags: e.target.value,
+ }))
+ }
+ placeholder={t(
+ 'Enter tags separated by commas'
+ )}
+ className="dark"
+ />
+
+ {t(
+ 'Public tags visible to all users (e.g., video, audio, utility)'
+ )}
+
+
+
+
+ {t('Admin Tags (comma separated)')}
+
+
+ setEditFormData((prev) => ({
+ ...prev,
+ tags_admin: e.target.value,
+ }))
+ }
+ placeholder={t(
+ 'Enter admin tags separated by commas'
+ )}
+ className="dark"
+ />
+
+ {t(
+ 'Admin-only tags for security warnings and metadata (e.g., dev, unsafe, fragile_deps)'
+ )}
+
+
+
+ {t('Press Ctrl+Enter to save')}
+
+
+
+
+
+ {updateNodeMutation.isPending ? (
+
+ ) : (
+ t('Save')
+ )}
+
+
+ {t('Cancel')}
+
+
+
+
+ )
+}
diff --git a/src/api/generated.ts b/src/api/generated.ts
index 09dcd862..47890bb3 100644
--- a/src/api/generated.ts
+++ b/src/api/generated.ts
@@ -1,89 +1,93 @@
/**
- * Generated by orval v7.13.0 🍺
+ * Generated by orval v7.13.2 🍺
* Do not edit manually.
* Comfy API
* OpenAPI spec version: 1.0
*/
-import { useMutation, useQuery } from "@tanstack/react-query";
+
import type {
- DataTag,
- DefinedInitialDataOptions,
- DefinedUseQueryResult,
- MutationFunction,
- QueryClient,
- QueryFunction,
- QueryKey,
- UndefinedInitialDataOptions,
- UseMutationOptions,
- UseMutationResult,
- UseQueryOptions,
- UseQueryResult,
-} from "@tanstack/react-query";
-
-import { customInstance } from "./mutator/axios-instance";
+ DataTag,
+ DefinedInitialDataOptions,
+ DefinedUseQueryResult,
+ MutationFunction,
+ QueryClient,
+ QueryFunction,
+ QueryKey,
+ UndefinedInitialDataOptions,
+ UseMutationOptions,
+ UseMutationResult,
+ UseQueryOptions,
+ UseQueryResult
+} from '@tanstack/react-query';
+import {
+ useMutation,
+ useQuery
+} from '@tanstack/react-query';
+
+import { customInstance } from './mutator/axios-instance';
export interface APIKey {
- created_at?: string;
- description?: string;
- id?: string;
- key_prefix?: string;
- name?: string;
+ created_at?: string;
+ description?: string;
+ id?: string;
+ key_prefix?: string;
+ name?: string;
}
export type APIKeyWithPlaintextAllOf = {
- /** The full API key (only returned at creation) */
- plaintext_key?: string;
+ /** The full API key (only returned at creation) */
+ plaintext_key?: string;
};
export type APIKeyWithPlaintext = APIKey & APIKeyWithPlaintextAllOf;
export interface ActionJobResult {
- /** Identifier of the job this result belongs to */
- action_job_id?: string;
- /** Identifier of the run this result belongs to */
- action_run_id?: string;
- /** The author of the commit */
- author?: string;
- /** The average VRAM used by the job */
- avg_vram?: number;
- /** Name of the relevant git branch */
- branch_name?: string;
- /** The comfy run flags. E.g. `--low-vram` */
- comfy_run_flags?: string;
- /** The hash of the commit */
- commit_hash?: string;
- /** The ID of the commit */
- commit_id?: string;
- /** The message of the commit */
- commit_message?: string;
- /** The Unix timestamp when the commit was made */
- commit_time?: number;
- /** CUDA version used */
- cuda_version?: string;
- /** The end time of the job as a Unix timestamp. */
- end_time?: number;
- /** The repository name */
- git_repo?: string;
- /** Unique identifier for the job result */
- id?: string;
- /** The user who triggered the job. */
- job_trigger_user?: string;
- machine_stats?: MachineStats;
- /** Operating system used */
- operating_system?: string;
- /** The peak VRAM used by the job */
- peak_vram?: number;
- /** The pull request number */
- pr_number?: string;
- /** PyTorch version used */
- python_version?: string;
- /** PyTorch version used */
- pytorch_version?: string;
- /** The start time of the job as a Unix timestamp. */
- start_time?: number;
- status?: WorkflowRunStatus;
- storage_file?: StorageFile;
- /** Name of the workflow */
- workflow_name?: string;
+ /** Identifier of the job this result belongs to */
+ action_job_id?: string;
+ /** Identifier of the run this result belongs to */
+ action_run_id?: string;
+ /** The author of the commit */
+ author?: string;
+ /** The average VRAM used by the job */
+ avg_vram?: number;
+ /** Name of the relevant git branch */
+ branch_name?: string;
+ /** The comfy run flags. E.g. `--low-vram` */
+ comfy_run_flags?: string;
+ /** The hash of the commit */
+ commit_hash?: string;
+ /** The ID of the commit */
+ commit_id?: string;
+ /** The message of the commit */
+ commit_message?: string;
+ /** The Unix timestamp when the commit was made */
+ commit_time?: number;
+ /** CUDA version used */
+ cuda_version?: string;
+ /** The end time of the job as a Unix timestamp. */
+ end_time?: number;
+ /** The repository name */
+ git_repo?: string;
+ /** Unique identifier for the job result */
+ id?: string;
+ /** The user who triggered the job. */
+ job_trigger_user?: string;
+ machine_stats?: MachineStats;
+ /** Operating system used */
+ operating_system?: string;
+ /** The peak VRAM used by the job */
+ peak_vram?: number;
+ /** The pull request number */
+ pr_number?: string;
+ /** PyTorch version used */
+ python_version?: string;
+ /** PyTorch version used */
+ pytorch_version?: string;
+ /** The start time of the job as a Unix timestamp. */
+ start_time?: number;
+ status?: WorkflowRunStatus;
+ storage_file?: StorageFile;
+ /** Name of the workflow */
+ workflow_name?: string;
}
/**
@@ -92,350 +96,350 @@ export interface ActionJobResult {
export type AuditLogParams = { [key: string]: unknown };
export interface AuditLog {
- /** The date and time the event was created */
- createdAt?: string;
- /** the id of the event */
- event_id?: string;
- /** the type of the event */
- event_type?: string;
- /** data related to the event */
- params?: AuditLogParams;
+ /** The date and time the event was created */
+ createdAt?: string;
+ /** the id of the event */
+ event_id?: string;
+ /** the type of the event */
+ event_type?: string;
+ /** data related to the event */
+ params?: AuditLogParams;
}
export interface BFLAsyncResponse {
- id: string;
- polling_url: string;
+ id: string;
+ polling_url: string;
}
export interface BFLAsyncWebhookResponse {
- id: string;
- status: string;
- webhook_url: string;
+ id: string;
+ status: string;
+ webhook_url: string;
}
export interface BFLCannyInputs {
- /** High threshold for Canny edge detection */
- canny_high_threshold?: number;
- /** Low threshold for Canny edge detection */
- canny_low_threshold?: number;
- /** Base64 encoded image to use as control input if no preprocessed image is provided */
- control_image?: string;
- /** Guidance strength for the image generation process */
- guidance?: number;
- /** Output format for the generated image. Can be 'jpeg' or 'png'. */
- output_format?: BFLOutputFormat;
- /** Optional pre-processed image that will bypass the control preprocessing step */
- preprocessed_image?: string;
- /** Text prompt for image generation */
- prompt: string;
- /** Whether to perform upsampling on the prompt */
- prompt_upsampling?: boolean;
- /**
- * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
- * @minimum 0
- * @maximum 6
- */
- safety_tolerance?: number;
- /** Optional seed for reproducibility */
- seed?: number;
- /** Number of steps for the image generation process */
- steps?: number;
- /** Optional secret for webhook signature verification */
- webhook_secret?: string;
- /** URL to receive webhook notifications */
- webhook_url?: string;
+ /** High threshold for Canny edge detection */
+ canny_high_threshold?: number;
+ /** Low threshold for Canny edge detection */
+ canny_low_threshold?: number;
+ /** Base64 encoded image to use as control input if no preprocessed image is provided */
+ control_image?: string;
+ /** Guidance strength for the image generation process */
+ guidance?: number;
+ /** Output format for the generated image. Can be 'jpeg' or 'png'. */
+ output_format?: BFLOutputFormat;
+ /** Optional pre-processed image that will bypass the control preprocessing step */
+ preprocessed_image?: string;
+ /** Text prompt for image generation */
+ prompt: string;
+ /** Whether to perform upsampling on the prompt */
+ prompt_upsampling?: boolean;
+ /**
+ * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
+ * @minimum 0
+ * @maximum 6
+ */
+ safety_tolerance?: number;
+ /** Optional seed for reproducibility */
+ seed?: number;
+ /** Number of steps for the image generation process */
+ steps?: number;
+ /** Optional secret for webhook signature verification */
+ webhook_secret?: string;
+ /** URL to receive webhook notifications */
+ webhook_url?: string;
}
export interface BFLDepthInputs {
- /** Base64 encoded image to use as control input */
- control_image?: string;
- /** Guidance strength for the image generation process */
- guidance?: number;
- /** Output format for the generated image. Can be 'jpeg' or 'png'. */
- output_format?: BFLOutputFormat;
- /** Optional pre-processed image that will bypass the control preprocessing step */
- preprocessed_image?: string;
- /** Text prompt for image generation */
- prompt: string;
- /** Whether to perform upsampling on the prompt */
- prompt_upsampling?: boolean;
- /**
- * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
- * @minimum 0
- * @maximum 6
- */
- safety_tolerance?: number;
- /** Optional seed for reproducibility */
- seed?: number;
- /** Number of steps for the image generation process */
- steps?: number;
- /** Optional secret for webhook signature verification */
- webhook_secret?: string;
- /** URL to receive webhook notifications */
- webhook_url?: string;
+ /** Base64 encoded image to use as control input */
+ control_image?: string;
+ /** Guidance strength for the image generation process */
+ guidance?: number;
+ /** Output format for the generated image. Can be 'jpeg' or 'png'. */
+ output_format?: BFLOutputFormat;
+ /** Optional pre-processed image that will bypass the control preprocessing step */
+ preprocessed_image?: string;
+ /** Text prompt for image generation */
+ prompt: string;
+ /** Whether to perform upsampling on the prompt */
+ prompt_upsampling?: boolean;
+ /**
+ * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
+ * @minimum 0
+ * @maximum 6
+ */
+ safety_tolerance?: number;
+ /** Optional seed for reproducibility */
+ seed?: number;
+ /** Number of steps for the image generation process */
+ steps?: number;
+ /** Optional secret for webhook signature verification */
+ webhook_secret?: string;
+ /** URL to receive webhook notifications */
+ webhook_url?: string;
}
export interface BFLFluxKontextMaxGenerateRequest {
- /**
- * The guidance scale for generation
- * @minimum 1
- * @maximum 20
- */
- guidance?: number;
- /** Base64 encoded image to be edited */
- input_image: string;
- /** The text prompt describing what to edit on the image */
- prompt: string;
- /**
- * Number of inference steps
- * @minimum 1
- * @maximum 50
- */
- steps?: number;
+ /**
+ * The guidance scale for generation
+ * @minimum 1
+ * @maximum 20
+ */
+ guidance?: number;
+ /** Base64 encoded image to be edited */
+ input_image: string;
+ /** The text prompt describing what to edit on the image */
+ prompt: string;
+ /**
+ * Number of inference steps
+ * @minimum 1
+ * @maximum 50
+ */
+ steps?: number;
}
export interface BFLFluxKontextMaxGenerateResponse {
- /** Job ID for tracking */
- id: string;
- /** URL to poll for results */
- polling_url: string;
+ /** Job ID for tracking */
+ id: string;
+ /** URL to poll for results */
+ polling_url: string;
}
export interface BFLFluxKontextProGenerateRequest {
- /**
- * The guidance scale for generation
- * @minimum 1
- * @maximum 20
- */
- guidance?: number;
- /** Base64 encoded image to be edited */
- input_image: string;
- /** The text prompt describing what to edit on the image */
- prompt: string;
- /**
- * Number of inference steps
- * @minimum 1
- * @maximum 50
- */
- steps?: number;
+ /**
+ * The guidance scale for generation
+ * @minimum 1
+ * @maximum 20
+ */
+ guidance?: number;
+ /** Base64 encoded image to be edited */
+ input_image: string;
+ /** The text prompt describing what to edit on the image */
+ prompt: string;
+ /**
+ * Number of inference steps
+ * @minimum 1
+ * @maximum 50
+ */
+ steps?: number;
}
export interface BFLFluxKontextProGenerateResponse {
- /** Job ID for tracking */
- id: string;
- /** URL to poll for results */
- polling_url: string;
+ /** Job ID for tracking */
+ id: string;
+ /** URL to poll for results */
+ polling_url: string;
}
/**
* Output image format
*/
-export type BFLFluxPro11GenerateRequestOutputFormat =
- (typeof BFLFluxPro11GenerateRequestOutputFormat)[keyof typeof BFLFluxPro11GenerateRequestOutputFormat];
+export type BFLFluxPro11GenerateRequestOutputFormat = typeof BFLFluxPro11GenerateRequestOutputFormat[keyof typeof BFLFluxPro11GenerateRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BFLFluxPro11GenerateRequestOutputFormat = {
- jpeg: "jpeg",
- png: "png",
+ jpeg: 'jpeg',
+ png: 'png',
} as const;
export interface BFLFluxPro11GenerateRequest {
- /** Height of the generated image */
- height: number;
- /** Optional image prompt */
- image_prompt?: string;
- /** Output image format */
- output_format?: BFLFluxPro11GenerateRequestOutputFormat;
- /** The main text prompt for image generation */
- prompt: string;
- /** Whether to use prompt upsampling */
- prompt_upsampling?: boolean;
- /** Safety tolerance level */
- safety_tolerance?: number;
- /** Random seed for reproducibility */
- seed?: number;
- /** Optional webhook secret for async processing */
- webhook_secret?: string;
- /** Optional webhook URL for async processing */
- webhook_url?: string;
- /** Width of the generated image */
- width: number;
+ /** Height of the generated image */
+ height: number;
+ /** Optional image prompt */
+ image_prompt?: string;
+ /** Output image format */
+ output_format?: BFLFluxPro11GenerateRequestOutputFormat;
+ /** The main text prompt for image generation */
+ prompt: string;
+ /** Whether to use prompt upsampling */
+ prompt_upsampling?: boolean;
+ /** Safety tolerance level */
+ safety_tolerance?: number;
+ /** Random seed for reproducibility */
+ seed?: number;
+ /** Optional webhook secret for async processing */
+ webhook_secret?: string;
+ /** Optional webhook URL for async processing */
+ webhook_url?: string;
+ /** Width of the generated image */
+ width: number;
}
export interface BFLFluxPro11GenerateResponse {
- /** Job ID for tracking */
- id: string;
- /** URL to poll for results */
- polling_url: string;
+ /** Job ID for tracking */
+ id: string;
+ /** URL to poll for results */
+ polling_url: string;
}
export interface BFLFluxProExpandInputs {
- /** Number of pixels to expand at the bottom of the image */
- bottom?: number;
- /** Guidance strength for the image generation process */
- guidance?: number;
- /** A Base64-encoded string representing the image you wish to expand. */
- image: string;
- /** Number of pixels to expand on the left side of the image */
- left?: number;
- /** Output format for the generated image. Can be 'jpeg' or 'png'. */
- output_format?: BFLOutputFormat;
- /** The description of the changes you want to make. This text guides the expansion process, allowing you to specify features, styles, or modifications for the expanded areas. */
- prompt?: string;
- /** Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation */
- prompt_upsampling?: boolean;
- /** Number of pixels to expand on the right side of the image */
- right?: number;
- /**
- * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
- * @minimum 0
- * @maximum 6
- */
- safety_tolerance?: number;
- /** Optional seed for reproducibility */
- seed?: number;
- /** Number of steps for the image generation process */
- steps?: number;
- /** Number of pixels to expand at the top of the image */
- top?: number;
- /** Optional secret for webhook signature verification */
- webhook_secret?: string;
- /** URL to receive webhook notifications */
- webhook_url?: string;
+ /** Number of pixels to expand at the bottom of the image */
+ bottom?: number;
+ /** Guidance strength for the image generation process */
+ guidance?: number;
+ /** A Base64-encoded string representing the image you wish to expand. */
+ image: string;
+ /** Number of pixels to expand on the left side of the image */
+ left?: number;
+ /** Output format for the generated image. Can be 'jpeg' or 'png'. */
+ output_format?: BFLOutputFormat;
+ /** The description of the changes you want to make. This text guides the expansion process, allowing you to specify features, styles, or modifications for the expanded areas. */
+ prompt?: string;
+ /** Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation */
+ prompt_upsampling?: boolean;
+ /** Number of pixels to expand on the right side of the image */
+ right?: number;
+ /**
+ * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
+ * @minimum 0
+ * @maximum 6
+ */
+ safety_tolerance?: number;
+ /** Optional seed for reproducibility */
+ seed?: number;
+ /** Number of steps for the image generation process */
+ steps?: number;
+ /** Number of pixels to expand at the top of the image */
+ top?: number;
+ /** Optional secret for webhook signature verification */
+ webhook_secret?: string;
+ /** URL to receive webhook notifications */
+ webhook_url?: string;
}
export interface BFLFluxProFillInputs {
- /** Guidance strength for the image generation process */
- guidance?: number;
- /** A Base64-encoded string representing the image you wish to modify. Can contain alpha mask if desired. */
- image: string;
- /** A Base64-encoded string representing a mask for the areas you want to modify in the image. The mask should be the same dimensions as the image and in black and white. Black areas (0%) indicate no modification, while white areas (100%) specify areas for inpainting. Optional if you provide an alpha mask in the original image. Validation: The endpoint verifies that the dimensions of the mask match the original image. */
- mask?: string;
- /** Output format for the generated image. Can be 'jpeg' or 'png'. */
- output_format?: BFLOutputFormat;
- /** The description of the changes you want to make. This text guides the inpainting process, allowing you to specify features, styles, or modifications for the masked area. */
- prompt?: string;
- /** Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation */
- prompt_upsampling?: boolean;
- /**
- * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
- * @minimum 0
- * @maximum 6
- */
- safety_tolerance?: number;
- /** Optional seed for reproducibility */
- seed?: number;
- /** Number of steps for the image generation process */
- steps?: number;
- /** Optional secret for webhook signature verification */
- webhook_secret?: string;
- /** URL to receive webhook notifications */
- webhook_url?: string;
+ /** Guidance strength for the image generation process */
+ guidance?: number;
+ /** A Base64-encoded string representing the image you wish to modify. Can contain alpha mask if desired. */
+ image: string;
+ /** A Base64-encoded string representing a mask for the areas you want to modify in the image. The mask should be the same dimensions as the image and in black and white. Black areas (0%) indicate no modification, while white areas (100%) specify areas for inpainting. Optional if you provide an alpha mask in the original image. Validation: The endpoint verifies that the dimensions of the mask match the original image. */
+ mask?: string;
+ /** Output format for the generated image. Can be 'jpeg' or 'png'. */
+ output_format?: BFLOutputFormat;
+ /** The description of the changes you want to make. This text guides the inpainting process, allowing you to specify features, styles, or modifications for the masked area. */
+ prompt?: string;
+ /** Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation */
+ prompt_upsampling?: boolean;
+ /**
+ * Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.
+ * @minimum 0
+ * @maximum 6
+ */
+ safety_tolerance?: number;
+ /** Optional seed for reproducibility */
+ seed?: number;
+ /** Number of steps for the image generation process */
+ steps?: number;
+ /** Optional secret for webhook signature verification */
+ webhook_secret?: string;
+ /** URL to receive webhook notifications */
+ webhook_url?: string;
}
/**
* Request body for the BFL Flux Pro 1.1 Ultra image generation API.
*/
export interface BFLFluxProGenerateRequest {
- /**
- * The guidance scale for generation.
- * @minimum 1
- * @maximum 20
- */
- guidance_scale?: number;
- /**
- * The height of the image to generate.
- * @minimum 64
- * @maximum 2048
- */
- height: number;
- /** The negative prompt for image generation. */
- negative_prompt?: string;
- /**
- * The number of images to generate.
- * @minimum 1
- * @maximum 4
- */
- num_images?: number;
- /**
- * The number of inference steps.
- * @minimum 1
- * @maximum 100
- */
- num_inference_steps?: number;
- /** The text prompt for image generation. */
- prompt: string;
- /** The seed value for reproducibility. */
- seed?: number;
- /**
- * The width of the image to generate.
- * @minimum 64
- * @maximum 2048
- */
- width: number;
+ /**
+ * The guidance scale for generation.
+ * @minimum 1
+ * @maximum 20
+ */
+ guidance_scale?: number;
+ /**
+ * The height of the image to generate.
+ * @minimum 64
+ * @maximum 2048
+ */
+ height: number;
+ /** The negative prompt for image generation. */
+ negative_prompt?: string;
+ /**
+ * The number of images to generate.
+ * @minimum 1
+ * @maximum 4
+ */
+ num_images?: number;
+ /**
+ * The number of inference steps.
+ * @minimum 1
+ * @maximum 100
+ */
+ num_inference_steps?: number;
+ /** The text prompt for image generation. */
+ prompt: string;
+ /** The seed value for reproducibility. */
+ seed?: number;
+ /**
+ * The width of the image to generate.
+ * @minimum 64
+ * @maximum 2048
+ */
+ width: number;
}
/**
* Response from the BFL Flux Pro 1.1 Ultra image generation API.
*/
export interface BFLFluxProGenerateResponse {
- /** The unique identifier for the generation task. */
- id: string;
- /** URL to poll for the generation result. */
- polling_url: string;
+ /** The unique identifier for the generation task. */
+ id: string;
+ /** URL to poll for the generation result. */
+ polling_url: string;
}
export interface BFLHTTPValidationError {
- detail?: BFLValidationError[];
+ detail?: BFLValidationError[];
}
-export type BFLOutputFormat =
- (typeof BFLOutputFormat)[keyof typeof BFLOutputFormat];
+export type BFLOutputFormat = typeof BFLOutputFormat[keyof typeof BFLOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BFLOutputFormat = {
- jpeg: "jpeg",
- png: "png",
+ jpeg: 'jpeg',
+ png: 'png',
} as const;
export type BFLValidationErrorLocItem = string | number;
export interface BFLValidationError {
- loc: BFLValidationErrorLocItem[];
- msg: string;
- type: string;
+ loc: BFLValidationErrorLocItem[];
+ msg: string;
+ type: string;
}
/**
* Status of the retrieval operation
*/
-export type BulkNodeVersionResultStatus =
- (typeof BulkNodeVersionResultStatus)[keyof typeof BulkNodeVersionResultStatus];
+export type BulkNodeVersionResultStatus = typeof BulkNodeVersionResultStatus[keyof typeof BulkNodeVersionResultStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BulkNodeVersionResultStatus = {
- success: "success",
- not_found: "not_found",
- error: "error",
+ success: 'success',
+ not_found: 'not_found',
+ error: 'error',
} as const;
export interface BulkNodeVersionResult {
- /** Error message if retrieval failed (only present if status is error) */
- error_message?: string;
- identifier: NodeVersionIdentifier;
- node_version?: NodeVersion;
- /** Status of the retrieval operation */
- status: BulkNodeVersionResultStatus;
+ /** Error message if retrieval failed (only present if status is error) */
+ error_message?: string;
+ identifier: NodeVersionIdentifier;
+ node_version?: NodeVersion;
+ /** Status of the retrieval operation */
+ status: BulkNodeVersionResultStatus;
}
export interface BulkNodeVersionsRequest {
- /** List of node ID and version pairs to retrieve */
- node_versions: NodeVersionIdentifier[];
+ /** List of node ID and version pairs to retrieve */
+ node_versions: NodeVersionIdentifier[];
}
export interface BulkNodeVersionsResponse {
- /** List of retrieved node versions with their status */
- node_versions: BulkNodeVersionResult[];
+ /** List of retrieved node versions with their status */
+ node_versions: BulkNodeVersionResult[];
}
/**
@@ -455,26 +459,26 @@ An input image must meet the following requirements:
*/
export type BytePlusImageGenerationRequestImage = string | string[];
-export type BytePlusImageGenerationRequestModel =
- (typeof BytePlusImageGenerationRequestModel)[keyof typeof BytePlusImageGenerationRequestModel];
+export type BytePlusImageGenerationRequestModel = typeof BytePlusImageGenerationRequestModel[keyof typeof BytePlusImageGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BytePlusImageGenerationRequestModel = {
- "seedream-3-0-t2i-250415": "seedream-3-0-t2i-250415",
- "seededit-3-0-i2i-250628": "seededit-3-0-i2i-250628",
- "seedream-4-0-250828": "seedream-4-0-250828",
+ 'seedream-3-0-t2i-250415': 'seedream-3-0-t2i-250415',
+ 'seededit-3-0-i2i-250628': 'seededit-3-0-i2i-250628',
+ 'seedream-4-0-250828': 'seedream-4-0-250828',
} as const;
/**
* Specifies the format of the generated image returned in the response
*/
-export type BytePlusImageGenerationRequestResponseFormat =
- (typeof BytePlusImageGenerationRequestResponseFormat)[keyof typeof BytePlusImageGenerationRequestResponseFormat];
+export type BytePlusImageGenerationRequestResponseFormat = typeof BytePlusImageGenerationRequestResponseFormat[keyof typeof BytePlusImageGenerationRequestResponseFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BytePlusImageGenerationRequestResponseFormat = {
- url: "url",
- b64_json: "b64_json",
+ url: 'url',
+ b64_json: 'b64_json',
} as const;
/**
@@ -483,22 +487,22 @@ Configuration for the batch image generation feature. This parameter is only eff
*/
export type BytePlusImageGenerationRequestSequentialImageGenerationOptions = {
- /**
- * Specifies the maximum number of images to generate in this request. Number of input reference images + Number of generated images ≤ 15.
- * @minimum 1
- * @maximum 15
- */
- max_images?: number;
+ /**
+ * Specifies the maximum number of images to generate in this request. Number of input reference images + Number of generated images ≤ 15.
+ * @minimum 1
+ * @maximum 15
+ */
+ max_images?: number;
};
export interface BytePlusImageGenerationRequest {
- /**
- * Controls how closely the output image aligns with the input prompt. Range [1, 10]. Higher values result in stronger prompt adherence. Default 2.5 for seedream-3-0-t2i-250415 and 5.5 for seededit-3-0-i2i-250628
- * @minimum 1
- * @maximum 10
- */
- guidance_scale?: number;
- /** Only seedream-4.0 and seededit-3.0-i2i support this parameter.
+ /**
+ * Controls how closely the output image aligns with the input prompt. Range [1, 10]. Higher values result in stronger prompt adherence. Default 2.5 for seedream-3-0-t2i-250415 and 5.5 for seededit-3-0-i2i-250628
+ * @minimum 1
+ * @maximum 10
+ */
+ guidance_scale?: number;
+ /** Only seedream-4.0 and seededit-3.0-i2i support this parameter.
Enter the Base64 encoding or an accessible URL of the image to edit. Among the models, bytedance-seedream-4.0 supports inputting a single image or multiple images (see the multi-image blending example), while bytedance-seededit-3.0-i2 only supports single-image input.
@@ -511,24 +515,24 @@ An input image must meet the following requirements:
• Width and height (px): > 14
• Size: No more than 10 MB
*/
- image?: BytePlusImageGenerationRequestImage;
- model: BytePlusImageGenerationRequestModel;
- /** Text description for image generation or transformation */
- prompt: string;
- /** Specifies the format of the generated image returned in the response */
- response_format?: BytePlusImageGenerationRequestResponseFormat;
- /** Random seed to control the stochasticity of image generation. Range: [-1, 2147483647]. If not specified, a seed will be automatically generated. To reproduce the same output, use the same seed value. */
- seed?: number;
- /** Controls whether to disable the batch generation feature. This parameter is only supported on seedream-4.0. Valid values:
+ image?: BytePlusImageGenerationRequestImage;
+ model: BytePlusImageGenerationRequestModel;
+ /** Text description for image generation or transformation */
+ prompt: string;
+ /** Specifies the format of the generated image returned in the response */
+ response_format?: BytePlusImageGenerationRequestResponseFormat;
+ /** Random seed to control the stochasticity of image generation. Range: [-1, 2147483647]. If not specified, a seed will be automatically generated. To reproduce the same output, use the same seed value. */
+ seed?: number;
+ /** Controls whether to disable the batch generation feature. This parameter is only supported on seedream-4.0. Valid values:
auto: In automatic mode, the model automatically determines whether to return multiple images and how many images it will contain based on the user's prompt.
disabled: Disables batch generation feature. The model will only generate one image.
*/
- sequential_image_generation?: string;
- /** Only seedream-4.0 supports this parameter.
+ sequential_image_generation?: string;
+ /** Only seedream-4.0 supports this parameter.
Configuration for the batch image generation feature. This parameter is only effective when sequential_image_generation is set to auto.
*/
- sequential_image_generation_options?: BytePlusImageGenerationRequestSequentialImageGenerationOptions;
- /** "seedream-3-0-t2i-250415": Specifies the dimensions (width x height in pixels) of the generated image. Must be between [512x512, 2048x2048]
+ sequential_image_generation_options?: BytePlusImageGenerationRequestSequentialImageGenerationOptions;
+ /** "seedream-3-0-t2i-250415": Specifies the dimensions (width x height in pixels) of the generated image. Must be between [512x512, 2048x2048]
"seededit-3-0-i2i-250628": The width and height pixels of the generated image. Currently only supports adaptive.
"seedream-4-0-250828": Set the specification for the generated image. Two methods are available but cannot be used together.
Method 1 | Example: Specify the resolution of the generated image, and describe its aspect ratio, shape, or purpose in the prompt using natural language, let the model ultimately determine the final image width and height.
@@ -538,72 +542,72 @@ Configuration for the batch image generation feature. This parameter is only eff
The value range of total pixels: [1024x1024, 4096x4096]
The aspect ratio value range: [1/16, 16]
*/
- size?: string;
- /** Specifies whether to add a watermark to the generated image. false = No watermark, true = Adds watermark with 'AI generated' label */
- watermark?: boolean;
+ size?: string;
+ /** Specifies whether to add a watermark to the generated image. false = No watermark, true = Adds watermark with 'AI generated' label */
+ watermark?: boolean;
}
export type BytePlusImageGenerationResponseDataItem = {
- /** Base64-encoded image data (if response_format is "b64_json") */
- b64_json?: string;
- /** URL for image download (if response_format is "url") */
- url?: string;
+ /** Base64-encoded image data (if response_format is "b64_json") */
+ b64_json?: string;
+ /** URL for image download (if response_format is "url") */
+ url?: string;
};
/**
* Error information (if any)
*/
export type BytePlusImageGenerationResponseError = {
- /** Error code */
- code?: string;
- /** Error message */
- message?: string;
+ /** Error code */
+ code?: string;
+ /** Error message */
+ message?: string;
};
export type BytePlusImageGenerationResponseUsage = {
- /** Number of images generated by the model */
- generated_images?: number;
- /** The number of tokens used for the picture generated by the model. */
- output_tokens?: number;
- /** The total number of tokens consumed by this request. */
- total_tokens?: number;
+ /** Number of images generated by the model */
+ generated_images?: number;
+ /** The number of tokens used for the picture generated by the model. */
+ output_tokens?: number;
+ /** The total number of tokens consumed by this request. */
+ total_tokens?: number;
};
export interface BytePlusImageGenerationResponse {
- /** Unix timestamp (in seconds) indicating the time when the request was created */
- created?: number;
- /** Contains information about the generated image(s) */
- data?: BytePlusImageGenerationResponseDataItem[];
- /** Error information (if any) */
- error?: BytePlusImageGenerationResponseError;
- /** The model ID used for the request */
- model?: string;
- usage?: BytePlusImageGenerationResponseUsage;
+ /** Unix timestamp (in seconds) indicating the time when the request was created */
+ created?: number;
+ /** Contains information about the generated image(s) */
+ data?: BytePlusImageGenerationResponseDataItem[];
+ /** Error information (if any) */
+ error?: BytePlusImageGenerationResponseError;
+ /** The model ID used for the request */
+ model?: string;
+ usage?: BytePlusImageGenerationResponseUsage;
}
export type BytePlusVideoGenerationContentImageUrl = {
- /** Image content for image-to-video generation (when type is "image")
+ /** Image content for image-to-video generation (when type is "image")
Image URL: Make sure that the image URL is accessible.
Base64-encoded content: Format must be data:image/;base64,
*/
- url?: string;
+ url?: string;
};
/**
* The type of the input content
*/
-export type BytePlusVideoGenerationContentType =
- (typeof BytePlusVideoGenerationContentType)[keyof typeof BytePlusVideoGenerationContentType];
+export type BytePlusVideoGenerationContentType = typeof BytePlusVideoGenerationContentType[keyof typeof BytePlusVideoGenerationContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BytePlusVideoGenerationContentType = {
- text: "text",
- image_url: "image_url",
+ text: 'text',
+ image_url: 'image_url',
} as const;
export interface BytePlusVideoGenerationContent {
- image_url?: BytePlusVideoGenerationContentImageUrl;
- /**
+ image_url?: BytePlusVideoGenerationContentImageUrl;
+ /**
* The input text information for the model. Includes text prompt and optional parameters.
Text prompt (required): Description of the video to be generated using Chinese and English characters.
@@ -621,17 +625,17 @@ Example: "A beautiful landscape --ratio 16:9 --resolution 720p --duration 5"
* @maxLength 4096
*/
- text?: string;
- /** The type of the input content */
- type: BytePlusVideoGenerationContentType;
+ text?: string;
+ /** The type of the input content */
+ type: BytePlusVideoGenerationContentType;
}
/**
* The output after the video generation task is completed, which contains the download URL of the output video.
*/
export type BytePlusVideoGenerationQueryResponseContent = {
- /** The URL of the output video. For security purposes, the output video is cleared after 24 hours. */
- video_url?: string;
+ /** The URL of the output video. For security purposes, the output video is cleared after 24 hours. */
+ video_url?: string;
};
/**
@@ -639,122 +643,155 @@ export type BytePlusVideoGenerationQueryResponseContent = {
* @nullable
*/
export type BytePlusVideoGenerationQueryResponseError = {
- /** The error code */
- code?: string;
- /** The error message */
- message?: string;
+ /** The error code */
+ code?: string;
+ /** The error message */
+ message?: string;
} | null;
/**
* The state of the task
*/
-export type BytePlusVideoGenerationQueryResponseStatus =
- (typeof BytePlusVideoGenerationQueryResponseStatus)[keyof typeof BytePlusVideoGenerationQueryResponseStatus];
+export type BytePlusVideoGenerationQueryResponseStatus = typeof BytePlusVideoGenerationQueryResponseStatus[keyof typeof BytePlusVideoGenerationQueryResponseStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BytePlusVideoGenerationQueryResponseStatus = {
- queued: "queued",
- running: "running",
- cancelled: "cancelled",
- succeeded: "succeeded",
- failed: "failed",
+ queued: 'queued',
+ running: 'running',
+ cancelled: 'cancelled',
+ succeeded: 'succeeded',
+ failed: 'failed',
} as const;
/**
* The token usage for the request
*/
export type BytePlusVideoGenerationQueryResponseUsage = {
- /** The number of tokens generated by the model */
- completion_tokens?: number;
- /** For the video generation model, the number of input tokens is not calculated and defaults to 0. Therefore, total_tokens = completion_tokens. */
- total_tokens?: number;
+ /** The number of tokens generated by the model */
+ completion_tokens?: number;
+ /** For the video generation model, the number of input tokens is not calculated and defaults to 0. Therefore, total_tokens = completion_tokens. */
+ total_tokens?: number;
};
export interface BytePlusVideoGenerationQueryResponse {
- /** The output after the video generation task is completed, which contains the download URL of the output video. */
- content?: BytePlusVideoGenerationQueryResponseContent;
- /** The time when the task was created. The value is a UNIX timestamp in seconds. */
- created_at?: number;
- /**
- * The error information. If the task succeeds, null is returned. If the task fails, the error information is returned.
- * @nullable
- */
- error?: BytePlusVideoGenerationQueryResponseError;
- /** The ID of the video generation task */
- id?: string;
- /** The name and version of the model used by the task */
- model?: string;
- /** The state of the task */
- status?: BytePlusVideoGenerationQueryResponseStatus;
- /** The time when the task was last updated. The value is a UNIX timestamp in seconds. */
- updated_at?: number;
- /** The token usage for the request */
- usage?: BytePlusVideoGenerationQueryResponseUsage;
+ /** The output after the video generation task is completed, which contains the download URL of the output video. */
+ content?: BytePlusVideoGenerationQueryResponseContent;
+ /** The time when the task was created. The value is a UNIX timestamp in seconds. */
+ created_at?: number;
+ /**
+ * The error information. If the task succeeds, null is returned. If the task fails, the error information is returned.
+ * @nullable
+ */
+ error?: BytePlusVideoGenerationQueryResponseError;
+ /** The ID of the video generation task */
+ id?: string;
+ /** The name and version of the model used by the task */
+ model?: string;
+ /** The state of the task */
+ status?: BytePlusVideoGenerationQueryResponseStatus;
+ /** The time when the task was last updated. The value is a UNIX timestamp in seconds. */
+ updated_at?: number;
+ /** The token usage for the request */
+ usage?: BytePlusVideoGenerationQueryResponseUsage;
}
/**
* The ID of the model to call. Available models include seedance-1-0-pro-250528, seedance-1-0-lite-t2v-250428, seedance-1-0-lite-i2v-250428
*/
-export type BytePlusVideoGenerationRequestModel =
- (typeof BytePlusVideoGenerationRequestModel)[keyof typeof BytePlusVideoGenerationRequestModel];
+export type BytePlusVideoGenerationRequestModel = typeof BytePlusVideoGenerationRequestModel[keyof typeof BytePlusVideoGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BytePlusVideoGenerationRequestModel = {
- "seedance-1-0-pro-250528": "seedance-1-0-pro-250528",
- "seedance-1-0-lite-t2v-250428": "seedance-1-0-lite-t2v-250428",
- "seedance-1-0-lite-i2v-250428": "seedance-1-0-lite-i2v-250428",
+ 'seedance-1-0-pro-250528': 'seedance-1-0-pro-250528',
+ 'seedance-1-0-lite-t2v-250428': 'seedance-1-0-lite-t2v-250428',
+ 'seedance-1-0-lite-i2v-250428': 'seedance-1-0-lite-i2v-250428',
} as const;
export interface BytePlusVideoGenerationRequest {
- /** Callback notification address for the result of this generation task */
- callback_url?: string;
- /**
- * The input content for the model to generate a video
- * @minItems 1
- */
- content: BytePlusVideoGenerationContent[];
- /** The ID of the model to call. Available models include seedance-1-0-pro-250528, seedance-1-0-lite-t2v-250428, seedance-1-0-lite-i2v-250428 */
- model: BytePlusVideoGenerationRequestModel;
+ /** Callback notification address for the result of this generation task */
+ callback_url?: string;
+ /**
+ * The input content for the model to generate a video
+ * @minItems 1
+ */
+ content: BytePlusVideoGenerationContent[];
+ /** The ID of the model to call. Available models include seedance-1-0-pro-250528, seedance-1-0-lite-t2v-250428, seedance-1-0-lite-i2v-250428 */
+ model: BytePlusVideoGenerationRequestModel;
}
export interface BytePlusVideoGenerationResponse {
- /** The ID of the video generation task */
- id: string;
+ /** The ID of the video generation task */
+ id: string;
}
export interface ClaimMyNodeRequest {
- /** GitHub token to verify if the user owns the repo of the node */
- GH_TOKEN: string;
+ /** GitHub token to verify if the user owns the repo of the node */
+ GH_TOKEN: string;
}
export interface ComfyNode {
- /** UI category where the node is listed, used for grouping nodes. */
- category?: string;
- /** Unique identifier for the node */
- comfy_node_name?: string;
- /** Indicates if the node is deprecated. Deprecated nodes are hidden in the UI. */
- deprecated?: boolean;
- /** Brief description of the node's functionality or purpose. */
- description?: string;
- /** Indicates if the node is experimental, subject to changes or removal. */
- experimental?: boolean;
- /** Name of the entry-point function to execute the node. */
- function?: string;
- /** Defines input parameters */
- input_types?: string;
- /** Boolean values indicating if each output is a list. */
- output_is_list?: boolean[];
- /** Names of the outputs for clarity in workflows. */
- return_names?: string;
- /** Specifies the types of outputs produced by the node. */
- return_types?: string;
+ /** UI category where the node is listed, used for grouping nodes. */
+ category?: string;
+ /** Unique identifier for the node */
+ comfy_node_name?: string;
+ /** Indicates if the node is deprecated. Deprecated nodes are hidden in the UI. */
+ deprecated?: boolean;
+ /** Brief description of the node's functionality or purpose. */
+ description?: string;
+ /** Indicates if the node is experimental, subject to changes or removal. */
+ experimental?: boolean;
+ /** Name of the entry-point function to execute the node. */
+ function?: string;
+ /** Defines input parameters */
+ input_types?: string;
+ /** Boolean values indicating if each output is a list. */
+ output_is_list?: boolean[];
+ policy?: ComfyNodePolicy;
+ /** Names of the outputs for clarity in workflows. */
+ return_names?: string;
+ /** Specifies the types of outputs produced by the node. */
+ return_types?: string;
}
export interface ComfyNodeCloudBuildInfo {
- build_id?: string;
- location?: string;
- project_id?: string;
- project_number?: string;
+ build_id?: string;
+ location?: string;
+ project_id?: string;
+ project_number?: string;
+}
+
+export type ComfyNodePolicy = typeof ComfyNodePolicy[keyof typeof ComfyNodePolicy];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ComfyNodePolicy = {
+ ComfyNodePolicyActive: 'ComfyNodePolicyActive',
+ ComfyNodePolicyBanned: 'ComfyNodePolicyBanned',
+ ComfyNodePolicyLocalOnly: 'ComfyNodePolicyLocalOnly',
+} as const;
+
+export interface ComfyNodeUpdateRequest {
+ /** UI category where the node is listed, used for grouping nodes. */
+ category?: string;
+ /** Indicates if the node is deprecated. Deprecated nodes are hidden in the UI. */
+ deprecated?: boolean;
+ /** Brief description of the node's functionality or purpose. */
+ description?: string;
+ /** Indicates if the node is experimental, subject to changes or removal. */
+ experimental?: boolean;
+ /** Name of the entry-point function to execute the node. */
+ function?: string;
+ /** Defines input parameters */
+ input_types?: string;
+ /** Boolean values indicating if each output is a list. */
+ output_is_list?: boolean[];
+ policy?: ComfyNodePolicy;
+ /** Names of the outputs for clarity in workflows. */
+ return_names?: string;
+ /** Specifies the types of outputs produced by the node. */
+ return_types?: string;
}
export type ComputerToolCallAction = { [key: string]: unknown };
@@ -764,25 +801,25 @@ export type ComputerToolCallAction = { [key: string]: unknown };
`incomplete`. Populated when items are returned via API.
*/
-export type ComputerToolCallStatus =
- (typeof ComputerToolCallStatus)[keyof typeof ComputerToolCallStatus];
+export type ComputerToolCallStatus = typeof ComputerToolCallStatus[keyof typeof ComputerToolCallStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ComputerToolCallStatus = {
- in_progress: "in_progress",
- completed: "completed",
- incomplete: "incomplete",
+ in_progress: 'in_progress',
+ completed: 'completed',
+ incomplete: 'incomplete',
} as const;
/**
* The type of the computer call. Always `computer_call`.
*/
-export type ComputerToolCallType =
- (typeof ComputerToolCallType)[keyof typeof ComputerToolCallType];
+export type ComputerToolCallType = typeof ComputerToolCallType[keyof typeof ComputerToolCallType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ComputerToolCallType = {
- computer_call: "computer_call",
+ computer_call: 'computer_call',
} as const;
/**
@@ -791,97 +828,97 @@ export const ComputerToolCallType = {
*/
export interface ComputerToolCall {
- action: ComputerToolCallAction;
- /** An identifier used when responding to the tool call with output.
- */
- call_id: string;
- /** The unique ID of the computer call. */
- id: string;
- /** The status of the item. One of `in_progress`, `completed`, or
+ action: ComputerToolCallAction;
+ /** An identifier used when responding to the tool call with output.
+ */
+ call_id: string;
+ /** The unique ID of the computer call. */
+ id: string;
+ /** The status of the item. One of `in_progress`, `completed`, or
`incomplete`. Populated when items are returned via API.
*/
- status: ComputerToolCallStatus;
- /** The type of the computer call. Always `computer_call`. */
- type: ComputerToolCallType;
+ status: ComputerToolCallStatus;
+ /** The type of the computer call. Always `computer_call`. */
+ type: ComputerToolCallType;
}
/**
* The type of computer environment to control.
*/
-export type ComputerUsePreviewToolEnvironment =
- (typeof ComputerUsePreviewToolEnvironment)[keyof typeof ComputerUsePreviewToolEnvironment];
+export type ComputerUsePreviewToolEnvironment = typeof ComputerUsePreviewToolEnvironment[keyof typeof ComputerUsePreviewToolEnvironment];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ComputerUsePreviewToolEnvironment = {
- windows: "windows",
- mac: "mac",
- linux: "linux",
- ubuntu: "ubuntu",
- browser: "browser",
+ windows: 'windows',
+ mac: 'mac',
+ linux: 'linux',
+ ubuntu: 'ubuntu',
+ browser: 'browser',
} as const;
/**
* The type of the computer use tool. Always `computer_use_preview`.
*/
-export type ComputerUsePreviewToolType =
- (typeof ComputerUsePreviewToolType)[keyof typeof ComputerUsePreviewToolType];
+export type ComputerUsePreviewToolType = typeof ComputerUsePreviewToolType[keyof typeof ComputerUsePreviewToolType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ComputerUsePreviewToolType = {
- computer_use_preview: "computer_use_preview",
+ computer_use_preview: 'computer_use_preview',
} as const;
/**
* A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
*/
export interface ComputerUsePreviewTool {
- /** The height of the computer display. */
- display_height: number;
- /** The width of the computer display. */
- display_width: number;
- /** The type of computer environment to control. */
- environment: ComputerUsePreviewToolEnvironment;
- /** The type of the computer use tool. Always `computer_use_preview`. */
- type: ComputerUsePreviewToolType;
+ /** The height of the computer display. */
+ display_height: number;
+ /** The width of the computer display. */
+ display_width: number;
+ /** The type of computer environment to control. */
+ environment: ComputerUsePreviewToolEnvironment;
+ /** The type of the computer use tool. Always `computer_use_preview`. */
+ type: ComputerUsePreviewToolType;
}
export interface CreateAPIKeyRequest {
- description?: string;
- name: string;
+ description?: string;
+ name: string;
}
export type CreateModelResponseProperties = ModelResponseProperties;
export interface Customer {
- /** The date and time the user was created */
- createdAt?: string;
- /** The email address for this user */
- email?: string;
- /** Whether the user has funds */
- has_fund?: boolean;
- /** The firebase UID of the user */
- id: string;
- /** Whether the user is an admin */
- is_admin?: boolean;
- /** The Metronome customer ID */
- metronome_id?: string;
- /** The name for this user */
- name?: string;
- /** The Stripe customer ID */
- stripe_id?: string;
- /** The date and time the user was last updated */
- updatedAt?: string;
+ /** The date and time the user was created */
+ createdAt?: string;
+ /** The email address for this user */
+ email?: string;
+ /** Whether the user has funds */
+ has_fund?: boolean;
+ /** The firebase UID of the user */
+ id: string;
+ /** Whether the user is an admin */
+ is_admin?: boolean;
+ /** The Metronome customer ID */
+ metronome_id?: string;
+ /** The name for this user */
+ name?: string;
+ /** The Stripe customer ID */
+ stripe_id?: string;
+ /** The date and time the user was last updated */
+ updatedAt?: string;
}
export interface CustomerStorageResourceResponse {
- /** The signed URL to use for downloading the file from the specified path */
- download_url?: string;
- /** Whether an existing file with the same hash was found */
- existing_file?: boolean;
- /** When the signed URL will expire */
- expires_at?: string;
- /** The signed URL to use for uploading the file to the specified path */
- upload_url?: string;
+ /** The signed URL to use for downloading the file from the specified path */
+ download_url?: string;
+ /** Whether an existing file with the same hash was found */
+ existing_file?: boolean;
+ /** When the signed URL will expire */
+ expires_at?: string;
+ /** The signed URL to use for uploading the file to the specified path */
+ upload_url?: string;
}
/**
@@ -896,27 +933,27 @@ export type EasyInputMessageContent = string | InputMessageContentList;
`developer`.
*/
-export type EasyInputMessageRole =
- (typeof EasyInputMessageRole)[keyof typeof EasyInputMessageRole];
+export type EasyInputMessageRole = typeof EasyInputMessageRole[keyof typeof EasyInputMessageRole];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EasyInputMessageRole = {
- user: "user",
- assistant: "assistant",
- system: "system",
- developer: "developer",
+ user: 'user',
+ assistant: 'assistant',
+ system: 'system',
+ developer: 'developer',
} as const;
/**
* The type of the message input. Always `message`.
*/
-export type EasyInputMessageType =
- (typeof EasyInputMessageType)[keyof typeof EasyInputMessageType];
+export type EasyInputMessageType = typeof EasyInputMessageType[keyof typeof EasyInputMessageType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EasyInputMessageType = {
- message: "message",
+ message: 'message',
} as const;
/**
@@ -928,62 +965,62 @@ interactions.
*/
export interface EasyInputMessage {
- /** Text, image, or audio input to the model, used to generate a response.
+ /** Text, image, or audio input to the model, used to generate a response.
Can also contain previous assistant responses.
*/
- content: EasyInputMessageContent;
- /** The role of the message input. One of `user`, `assistant`, `system`, or
+ content: EasyInputMessageContent;
+ /** The role of the message input. One of `user`, `assistant`, `system`, or
`developer`.
*/
- role: EasyInputMessageRole;
- /** The type of the message input. Always `message`.
- */
- type?: EasyInputMessageType;
+ role: EasyInputMessageRole;
+ /** The type of the message input. Always `message`.
+ */
+ type?: EasyInputMessageType;
}
export interface Error {
- /** Optional detailed information about the error or hints for resolving it. */
- details?: string[];
- /** A clear and concise description of the error. */
- message?: string;
+ /** Optional detailed information about the error or hints for resolving it. */
+ details?: string[];
+ /** A clear and concise description of the error. */
+ message?: string;
}
export interface ErrorResponse {
- error: string;
- message: string;
+ error: string;
+ message: string;
}
/**
* The type of tool
*/
-export type FileSearchToolType =
- (typeof FileSearchToolType)[keyof typeof FileSearchToolType];
+export type FileSearchToolType = typeof FileSearchToolType[keyof typeof FileSearchToolType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FileSearchToolType = {
- file_search: "file_search",
+ file_search: 'file_search',
} as const;
export interface FileSearchTool {
- /** The type of tool */
- type: FileSearchToolType;
- /** IDs of vector stores to search in */
- vector_store_ids: string[];
+ /** The type of tool */
+ type: FileSearchToolType;
+ /** IDs of vector stores to search in */
+ vector_store_ids: string[];
}
export type FileSearchToolCallResultsItem = {
- /** The unique ID of the file.
- */
- file_id?: string;
- /** The name of the file.
- */
- filename?: string;
- /** The relevance score of the file - a value between 0 and 1.
- */
- score?: number;
- /** The text that was retrieved from the file.
- */
- text?: string;
+ /** The unique ID of the file.
+ */
+ file_id?: string;
+ /** The name of the file.
+ */
+ filename?: string;
+ /** The relevance score of the file - a value between 0 and 1.
+ */
+ score?: number;
+ /** The text that was retrieved from the file.
+ */
+ text?: string;
};
/**
@@ -991,28 +1028,28 @@ export type FileSearchToolCallResultsItem = {
`searching`, `incomplete` or `failed`,
*/
-export type FileSearchToolCallStatus =
- (typeof FileSearchToolCallStatus)[keyof typeof FileSearchToolCallStatus];
+export type FileSearchToolCallStatus = typeof FileSearchToolCallStatus[keyof typeof FileSearchToolCallStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FileSearchToolCallStatus = {
- in_progress: "in_progress",
- searching: "searching",
- completed: "completed",
- incomplete: "incomplete",
- failed: "failed",
+ in_progress: 'in_progress',
+ searching: 'searching',
+ completed: 'completed',
+ incomplete: 'incomplete',
+ failed: 'failed',
} as const;
/**
* The type of the file search tool call. Always `file_search_call`.
*/
-export type FileSearchToolCallType =
- (typeof FileSearchToolCallType)[keyof typeof FileSearchToolCallType];
+export type FileSearchToolCallType = typeof FileSearchToolCallType[keyof typeof FileSearchToolCallType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FileSearchToolCallType = {
- file_search_call: "file_search_call",
+ file_search_call: 'file_search_call',
} as const;
/**
@@ -1021,22 +1058,22 @@ export const FileSearchToolCallType = {
*/
export interface FileSearchToolCall {
- /** The unique ID of the file search tool call.
- */
- id: string;
- /** The queries used to search for files.
- */
- queries: string[];
- /** The results of the file search tool call.
- */
- results?: FileSearchToolCallResultsItem[];
- /** The status of the file search tool call. One of `in_progress`,
+ /** The unique ID of the file search tool call.
+ */
+ id: string;
+ /** The queries used to search for files.
+ */
+ queries: string[];
+ /** The results of the file search tool call.
+ */
+ results?: FileSearchToolCallResultsItem[];
+ /** The status of the file search tool call. One of `in_progress`,
`searching`, `incomplete` or `failed`,
*/
- status: FileSearchToolCallStatus;
- /** The type of the file search tool call. Always `file_search_call`.
- */
- type: FileSearchToolCallType;
+ status: FileSearchToolCallStatus;
+ /** The type of the file search tool call. Always `file_search_call`.
+ */
+ type: FileSearchToolCallType;
}
/**
@@ -1047,23 +1084,23 @@ export type FunctionToolParameters = { [key: string]: unknown };
/**
* The type of tool
*/
-export type FunctionToolType =
- (typeof FunctionToolType)[keyof typeof FunctionToolType];
+export type FunctionToolType = typeof FunctionToolType[keyof typeof FunctionToolType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FunctionToolType = {
- function: "function",
+ function: 'function',
} as const;
export interface FunctionTool {
- /** Description of what the function does */
- description?: string;
- /** Name of the function */
- name: string;
- /** JSON Schema object describing the function parameters */
- parameters: FunctionToolParameters;
- /** The type of tool */
- type: FunctionToolType;
+ /** Description of what the function does */
+ description?: string;
+ /** Name of the function */
+ name: string;
+ /** JSON Schema object describing the function parameters */
+ parameters: FunctionToolParameters;
+ /** The type of tool */
+ type: FunctionToolType;
}
/**
@@ -1071,26 +1108,26 @@ export interface FunctionTool {
`incomplete`. Populated when items are returned via API.
*/
-export type FunctionToolCallStatus =
- (typeof FunctionToolCallStatus)[keyof typeof FunctionToolCallStatus];
+export type FunctionToolCallStatus = typeof FunctionToolCallStatus[keyof typeof FunctionToolCallStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FunctionToolCallStatus = {
- in_progress: "in_progress",
- completed: "completed",
- incomplete: "incomplete",
+ in_progress: 'in_progress',
+ completed: 'completed',
+ incomplete: 'incomplete',
} as const;
/**
* The type of the function tool call. Always `function_call`.
*/
-export type FunctionToolCallType =
- (typeof FunctionToolCallType)[keyof typeof FunctionToolCallType];
+export type FunctionToolCallType = typeof FunctionToolCallType[keyof typeof FunctionToolCallType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const FunctionToolCallType = {
- function_call: "function_call",
+ function_call: 'function_call',
} as const;
/**
@@ -1099,55 +1136,55 @@ export const FunctionToolCallType = {
*/
export interface FunctionToolCall {
- /** A JSON string of the arguments to pass to the function.
- */
- arguments: string;
- /** The unique ID of the function tool call generated by the model.
- */
- call_id: string;
- /** The unique ID of the function tool call.
- */
- id?: string;
- /** The name of the function to run.
- */
- name: string;
- /** The status of the item. One of `in_progress`, `completed`, or
+ /** A JSON string of the arguments to pass to the function.
+ */
+ arguments: string;
+ /** The unique ID of the function tool call generated by the model.
+ */
+ call_id: string;
+ /** The unique ID of the function tool call.
+ */
+ id?: string;
+ /** The name of the function to run.
+ */
+ name: string;
+ /** The status of the item. One of `in_progress`, `completed`, or
`incomplete`. Populated when items are returned via API.
*/
- status?: FunctionToolCallStatus;
- /** The type of the function tool call. Always `function_call`.
- */
- type: FunctionToolCallType;
+ status?: FunctionToolCallStatus;
+ /** The type of the function tool call. Always `function_call`.
+ */
+ type: FunctionToolCallType;
}
export interface GeminiCandidate {
- citationMetadata?: GeminiCitationMetadata;
- content?: GeminiContent;
- finishReason?: string;
- safetyRatings?: GeminiSafetyRating[];
+ citationMetadata?: GeminiCitationMetadata;
+ content?: GeminiContent;
+ finishReason?: string;
+ safetyRatings?: GeminiSafetyRating[];
}
export interface GeminiCitation {
- authors?: string[];
- endIndex?: number;
- license?: string;
- publicationDate?: string;
- startIndex?: number;
- title?: string;
- uri?: string;
+ authors?: string[];
+ endIndex?: number;
+ license?: string;
+ publicationDate?: string;
+ startIndex?: number;
+ title?: string;
+ uri?: string;
}
export interface GeminiCitationMetadata {
- citations?: GeminiCitation[];
+ citations?: GeminiCitation[];
}
-export type GeminiContentRole =
- (typeof GeminiContentRole)[keyof typeof GeminiContentRole];
+export type GeminiContentRole = typeof GeminiContentRole[keyof typeof GeminiContentRole];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiContentRole = {
- user: "user",
- model: "model",
+ user: 'user',
+ model: 'model',
} as const;
/**
@@ -1155,8 +1192,8 @@ export const GeminiContentRole = {
*/
export interface GeminiContent {
- parts: GeminiPart[];
- role: GeminiContentRole;
+ parts: GeminiPart[];
+ role: GeminiContentRole;
}
/**
@@ -1165,63 +1202,73 @@ export interface GeminiContent {
export type GeminiFunctionDeclarationParameters = { [key: string]: unknown };
export interface GeminiFunctionDeclaration {
- description?: string;
- name: string;
- /** JSON schema for the function parameters */
- parameters: GeminiFunctionDeclarationParameters;
+ description?: string;
+ name: string;
+ /** JSON schema for the function parameters */
+ parameters: GeminiFunctionDeclarationParameters;
}
export interface GeminiGenerateContentRequest {
- contents: GeminiContent[];
- generationConfig?: GeminiGenerationConfig;
- safetySettings?: GeminiSafetySetting[];
- systemInstruction?: GeminiSystemInstructionContent;
- tools?: GeminiTool[];
- videoMetadata?: GeminiVideoMetadata;
+ contents: GeminiContent[];
+ generationConfig?: GeminiGenerationConfig;
+ safetySettings?: GeminiSafetySetting[];
+ systemInstruction?: GeminiSystemInstructionContent;
+ tools?: GeminiTool[];
+ videoMetadata?: GeminiVideoMetadata;
}
export interface GeminiGenerateContentResponse {
- candidates?: GeminiCandidate[];
- promptFeedback?: GeminiPromptFeedback;
- usageMetadata?: GeminiUsageMetadata;
+ candidates?: GeminiCandidate[];
+ promptFeedback?: GeminiPromptFeedback;
+ usageMetadata?: GeminiUsageMetadata;
}
-export type GeminiGenerationConfigResponseModalitiesItem =
- (typeof GeminiGenerationConfigResponseModalitiesItem)[keyof typeof GeminiGenerationConfigResponseModalitiesItem];
+/**
+ * Configuration for image generation
+ */
+export type GeminiGenerationConfigImageConfig = {
+ /** Aspect ratio for generated images */
+ aspectRatio?: string;
+};
+
+export type GeminiGenerationConfigResponseModalitiesItem = typeof GeminiGenerationConfigResponseModalitiesItem[keyof typeof GeminiGenerationConfigResponseModalitiesItem];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiGenerationConfigResponseModalitiesItem = {
- TEXT: "TEXT",
- IMAGE: "IMAGE",
+ TEXT: 'TEXT',
+ IMAGE: 'IMAGE',
} as const;
export interface GeminiGenerationConfig {
- /**
+ /** Configuration for image generation */
+ imageConfig?: GeminiGenerationConfigImageConfig;
+ /**
* Maximum number of tokens that can be generated in the response. A token is approximately 4 characters. 100 tokens correspond to roughly 60-80 words.
* @minimum 16
* @maximum 8192
*/
- maxOutputTokens?: number;
- responseModalities?: GeminiGenerationConfigResponseModalitiesItem[];
- /** When seed is fixed to a specific value, the model makes a best effort to provide the same response for repeated requests. Deterministic output isn't guaranteed. Also, changing the model or parameter settings, such as the temperature, can cause variations in the response even when you use the same seed value. By default, a random seed value is used. Available for the following models:, gemini-2.5-flash, gemini-2.5-pro, gemini-2.5-flash-preview-04-1, gemini-2.5-pro-preview-05-0, gemini-2.0-flash-lite-00, gemini-2.0-flash-001
- */
- seed?: number;
- stopSequences?: string[];
- /**
+ maxOutputTokens?: number;
+ responseModalities?: GeminiGenerationConfigResponseModalitiesItem[];
+ /** When seed is fixed to a specific value, the model makes a best effort to provide the same response for repeated requests. Deterministic output isn't guaranteed. Also, changing the model or parameter settings, such as the temperature, can cause variations in the response even when you use the same seed value. By default, a random seed value is used. Available for the following models:, gemini-2.5-flash, gemini-2.5-pro, gemini-2.5-flash-preview-04-1, gemini-2.5-pro-preview-05-0, gemini-2.0-flash-lite-00, gemini-2.0-flash-001
+ */
+ seed?: number;
+ stopSequences?: string[];
+ /**
* The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature
* @minimum 0
* @maximum 2
*/
- temperature?: number;
- /**
+ temperature?: number;
+ /**
* Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary. A top-K of 3 means that the next token is selected from among the 3 most probable tokens by using temperature.
* @minimum 1
*/
- topK?: number;
- /**
+ topK?: number;
+ /**
* If specified, nucleus sampling is used.
Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate.
Specify a lower value for less random responses and a higher value for more random responses.
@@ -1229,7 +1276,7 @@ Specify a lower value for less random responses and a higher value for more rand
* @minimum 0
* @maximum 1
*/
- topP?: number;
+ topP?: number;
}
/**
@@ -1237,36 +1284,36 @@ Specify a lower value for less random responses and a higher value for more rand
*/
export interface GeminiInlineData {
- /** The base64 encoding of the image, PDF, or video to include inline in the prompt. When including media inline, you must also specify the media type (mimeType) of the data. Size limit: 20MB
- */
- data?: string;
- mimeType?: GeminiMimeType;
+ /** The base64 encoding of the image, PDF, or video to include inline in the prompt. When including media inline, you must also specify the media type (mimeType) of the data. Size limit: 20MB
+ */
+ data?: string;
+ mimeType?: GeminiMimeType;
}
/**
* The media type of the file specified in the data or fileUri fields. Acceptable values include the following. For gemini-2.0-flash-lite and gemini-2.0-flash, the maximum length of an audio file is 8.4 hours and the maximum length of a video file (without audio) is one hour. For more information, see Gemini audio and video requirements. Text files must be UTF-8 encoded. The contents of the text file count toward the token limit. There is no limit on image resolution.
*/
-export type GeminiMimeType =
- (typeof GeminiMimeType)[keyof typeof GeminiMimeType];
+export type GeminiMimeType = typeof GeminiMimeType[keyof typeof GeminiMimeType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiMimeType = {
- "application/pdf": "application/pdf",
- "audio/mpeg": "audio/mpeg",
- "audio/mp3": "audio/mp3",
- "audio/wav": "audio/wav",
- "image/png": "image/png",
- "image/jpeg": "image/jpeg",
- "image/webp": "image/webp",
- "text/plain": "text/plain",
- "video/mov": "video/mov",
- "video/mpeg": "video/mpeg",
- "video/mp4": "video/mp4",
- "video/mpg": "video/mpg",
- "video/avi": "video/avi",
- "video/wmv": "video/wmv",
- "video/mpegps": "video/mpegps",
- "video/flv": "video/flv",
+ 'application/pdf': 'application/pdf',
+ 'audio/mpeg': 'audio/mpeg',
+ 'audio/mp3': 'audio/mp3',
+ 'audio/wav': 'audio/wav',
+ 'image/png': 'image/png',
+ 'image/jpeg': 'image/jpeg',
+ 'image/webp': 'image/webp',
+ 'text/plain': 'text/plain',
+ 'video/mov': 'video/mov',
+ 'video/mpeg': 'video/mpeg',
+ 'video/mp4': 'video/mp4',
+ 'video/mpg': 'video/mpg',
+ 'video/avi': 'video/avi',
+ 'video/wmv': 'video/wmv',
+ 'video/mpegps': 'video/mpegps',
+ 'video/flv': 'video/flv',
} as const;
/**
@@ -1274,64 +1321,64 @@ export const GeminiMimeType = {
*/
export interface GeminiOffset {
- /**
+ /**
* Signed fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values.
* @minimum 0
* @maximum 999999999
*/
- nanos?: number;
- /**
+ nanos?: number;
+ /**
* Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
* @minimum -315576000000
* @maximum 315576000000
*/
- seconds?: number;
+ seconds?: number;
}
export interface GeminiPart {
- inlineData?: GeminiInlineData;
- /** A text prompt or code snippet. */
- text?: string;
+ inlineData?: GeminiInlineData;
+ /** A text prompt or code snippet. */
+ text?: string;
}
export interface GeminiPromptFeedback {
- blockReason?: string;
- blockReasonMessage?: string;
- safetyRatings?: GeminiSafetyRating[];
+ blockReason?: string;
+ blockReasonMessage?: string;
+ safetyRatings?: GeminiSafetyRating[];
}
-export type GeminiSafetyCategory =
- (typeof GeminiSafetyCategory)[keyof typeof GeminiSafetyCategory];
+export type GeminiSafetyCategory = typeof GeminiSafetyCategory[keyof typeof GeminiSafetyCategory];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiSafetyCategory = {
- HARM_CATEGORY_SEXUALLY_EXPLICIT: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
- HARM_CATEGORY_HATE_SPEECH: "HARM_CATEGORY_HATE_SPEECH",
- HARM_CATEGORY_HARASSMENT: "HARM_CATEGORY_HARASSMENT",
- HARM_CATEGORY_DANGEROUS_CONTENT: "HARM_CATEGORY_DANGEROUS_CONTENT",
+ HARM_CATEGORY_SEXUALLY_EXPLICIT: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
+ HARM_CATEGORY_HATE_SPEECH: 'HARM_CATEGORY_HATE_SPEECH',
+ HARM_CATEGORY_HARASSMENT: 'HARM_CATEGORY_HARASSMENT',
+ HARM_CATEGORY_DANGEROUS_CONTENT: 'HARM_CATEGORY_DANGEROUS_CONTENT',
} as const;
/**
* The probability that the content violates the specified safety category
*/
-export type GeminiSafetyRatingProbability =
- (typeof GeminiSafetyRatingProbability)[keyof typeof GeminiSafetyRatingProbability];
+export type GeminiSafetyRatingProbability = typeof GeminiSafetyRatingProbability[keyof typeof GeminiSafetyRatingProbability];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiSafetyRatingProbability = {
- NEGLIGIBLE: "NEGLIGIBLE",
- LOW: "LOW",
- MEDIUM: "MEDIUM",
- HIGH: "HIGH",
- UNKNOWN: "UNKNOWN",
+ NEGLIGIBLE: 'NEGLIGIBLE',
+ LOW: 'LOW',
+ MEDIUM: 'MEDIUM',
+ HIGH: 'HIGH',
+ UNKNOWN: 'UNKNOWN',
} as const;
export interface GeminiSafetyRating {
- category?: GeminiSafetyCategory;
- /** The probability that the content violates the specified safety category */
- probability?: GeminiSafetyRatingProbability;
+ category?: GeminiSafetyCategory;
+ /** The probability that the content violates the specified safety category */
+ probability?: GeminiSafetyRatingProbability;
}
/**
@@ -1339,33 +1386,33 @@ export interface GeminiSafetyRating {
*/
export interface GeminiSafetySetting {
- category: GeminiSafetyCategory;
- threshold: GeminiSafetyThreshold;
+ category: GeminiSafetyCategory;
+ threshold: GeminiSafetyThreshold;
}
-export type GeminiSafetyThreshold =
- (typeof GeminiSafetyThreshold)[keyof typeof GeminiSafetyThreshold];
+export type GeminiSafetyThreshold = typeof GeminiSafetyThreshold[keyof typeof GeminiSafetyThreshold];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiSafetyThreshold = {
- OFF: "OFF",
- BLOCK_NONE: "BLOCK_NONE",
- BLOCK_LOW_AND_ABOVE: "BLOCK_LOW_AND_ABOVE",
- BLOCK_MEDIUM_AND_ABOVE: "BLOCK_MEDIUM_AND_ABOVE",
- BLOCK_ONLY_HIGH: "BLOCK_ONLY_HIGH",
+ OFF: 'OFF',
+ BLOCK_NONE: 'BLOCK_NONE',
+ BLOCK_LOW_AND_ABOVE: 'BLOCK_LOW_AND_ABOVE',
+ BLOCK_MEDIUM_AND_ABOVE: 'BLOCK_MEDIUM_AND_ABOVE',
+ BLOCK_ONLY_HIGH: 'BLOCK_ONLY_HIGH',
} as const;
/**
* The identity of the entity that creates the message. The following values are supported: user: This indicates that the message is sent by a real person, typically a user-generated message. model: This indicates that the message is generated by the model. The model value is used to insert messages from the model into the conversation during multi-turn conversations. For non-multi-turn conversations, this field can be left blank or unset.
*/
-export type GeminiSystemInstructionContentRole =
- (typeof GeminiSystemInstructionContentRole)[keyof typeof GeminiSystemInstructionContentRole];
+export type GeminiSystemInstructionContentRole = typeof GeminiSystemInstructionContentRole[keyof typeof GeminiSystemInstructionContentRole];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GeminiSystemInstructionContentRole = {
- user: "user",
- model: "model",
+ user: 'user',
+ model: 'model',
} as const;
/**
@@ -1373,17 +1420,17 @@ export const GeminiSystemInstructionContentRole = {
*/
export interface GeminiSystemInstructionContent {
- /** A list of ordered parts that make up a single message. Different parts may have different IANA MIME types. For limits on the inputs, such as the maximum number of tokens or the number of images, see the model specifications on the Google models page.
- */
- parts: GeminiTextPart[];
- /** The identity of the entity that creates the message. The following values are supported: user: This indicates that the message is sent by a real person, typically a user-generated message. model: This indicates that the message is generated by the model. The model value is used to insert messages from the model into the conversation during multi-turn conversations. For non-multi-turn conversations, this field can be left blank or unset.
- */
- role: GeminiSystemInstructionContentRole;
+ /** A list of ordered parts that make up a single message. Different parts may have different IANA MIME types. For limits on the inputs, such as the maximum number of tokens or the number of images, see the model specifications on the Google models page.
+ */
+ parts: GeminiTextPart[];
+ /** The identity of the entity that creates the message. The following values are supported: user: This indicates that the message is sent by a real person, typically a user-generated message. model: This indicates that the message is generated by the model. The model value is used to insert messages from the model into the conversation during multi-turn conversations. For non-multi-turn conversations, this field can be left blank or unset.
+ */
+ role: GeminiSystemInstructionContentRole;
}
export interface GeminiTextPart {
- /** A text prompt or code snippet. */
- text?: string;
+ /** A text prompt or code snippet. */
+ text?: string;
}
/**
@@ -1391,24 +1438,24 @@ export interface GeminiTextPart {
*/
export interface GeminiTool {
- functionDeclarations?: GeminiFunctionDeclaration[];
+ functionDeclarations?: GeminiFunctionDeclaration[];
}
export interface GeminiUsageMetadata {
- /** Output only. Number of tokens in the cached part in the input (the cached content). */
- cachedContentTokenCount?: number;
- /** Number of tokens in the response(s). */
- candidatesTokenCount?: number;
- /** Breakdown of candidate tokens by modality. */
- candidatesTokensDetails?: ModalityTokenCount[];
- /** Number of tokens in the request. When cachedContent is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */
- promptTokenCount?: number;
- /** Breakdown of prompt tokens by modality. */
- promptTokensDetails?: ModalityTokenCount[];
- /** Number of tokens present in thoughts output. */
- thoughtsTokenCount?: number;
- /** Number of tokens present in tool-use prompt(s). */
- toolUsePromptTokenCount?: number;
+ /** Output only. Number of tokens in the cached part in the input (the cached content). */
+ cachedContentTokenCount?: number;
+ /** Number of tokens in the response(s). */
+ candidatesTokenCount?: number;
+ /** Breakdown of candidate tokens by modality. */
+ candidatesTokensDetails?: ModalityTokenCount[];
+ /** Number of tokens in the request. When cachedContent is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */
+ promptTokenCount?: number;
+ /** Breakdown of prompt tokens by modality. */
+ promptTokensDetails?: ModalityTokenCount[];
+ /** Number of tokens present in thoughts output. */
+ thoughtsTokenCount?: number;
+ /** Number of tokens present in tool-use prompt(s). */
+ toolUsePromptTokenCount?: number;
}
/**
@@ -1416,60 +1463,60 @@ export interface GeminiUsageMetadata {
*/
export interface GeminiVideoMetadata {
- endOffset?: GeminiOffset;
- startOffset?: GeminiOffset;
+ endOffset?: GeminiOffset;
+ startOffset?: GeminiOffset;
}
/**
* A map of operating system to status pairs
*/
-export type GitCommitSummaryStatusSummary = { [key: string]: string };
+export type GitCommitSummaryStatusSummary = {[key: string]: string};
export interface GitCommitSummary {
- /** The author of the commit */
- author?: string;
- /** The branch where the commit was made */
- branch_name?: string;
- /** The hash of the commit */
- commit_hash?: string;
- /** The name of the commit */
- commit_name?: string;
- /** A map of operating system to status pairs */
- status_summary?: GitCommitSummaryStatusSummary;
- /** The timestamp when the commit was made */
- timestamp?: string;
+ /** The author of the commit */
+ author?: string;
+ /** The branch where the commit was made */
+ branch_name?: string;
+ /** The hash of the commit */
+ commit_hash?: string;
+ /** The name of the commit */
+ commit_name?: string;
+ /** A map of operating system to status pairs */
+ status_summary?: GitCommitSummaryStatusSummary;
+ /** The timestamp when the commit was made */
+ timestamp?: string;
}
/**
* A GitHub enterprise
*/
export interface GithubEnterprise {
- /** URL to the enterprise avatar */
- avatar_url: string;
- /** When the enterprise was created */
- created_at: string;
- /**
- * The enterprise description
- * @nullable
- */
- description?: string | null;
- /** The HTML URL of the enterprise */
- html_url: string;
- /** The enterprise ID */
- id: number;
- /** The enterprise name */
- name: string;
- /** The enterprise node ID */
- node_id: string;
- /** The enterprise slug */
- slug: string;
- /** When the enterprise was last updated */
- updated_at: string;
- /**
- * The enterprise website URL
- * @nullable
- */
- website_url?: string | null;
+ /** URL to the enterprise avatar */
+ avatar_url: string;
+ /** When the enterprise was created */
+ created_at: string;
+ /**
+ * The enterprise description
+ * @nullable
+ */
+ description?: string | null;
+ /** The HTML URL of the enterprise */
+ html_url: string;
+ /** The enterprise ID */
+ id: number;
+ /** The enterprise name */
+ name: string;
+ /** The enterprise node ID */
+ node_id: string;
+ /** The enterprise slug */
+ slug: string;
+ /** When the enterprise was last updated */
+ updated_at: string;
+ /**
+ * The enterprise website URL
+ * @nullable
+ */
+ website_url?: string | null;
}
/**
@@ -1480,687 +1527,681 @@ export type GithubInstallationPermissions = { [key: string]: unknown };
/**
* Repository selection for the installation
*/
-export type GithubInstallationRepositorySelection =
- (typeof GithubInstallationRepositorySelection)[keyof typeof GithubInstallationRepositorySelection];
+export type GithubInstallationRepositorySelection = typeof GithubInstallationRepositorySelection[keyof typeof GithubInstallationRepositorySelection];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GithubInstallationRepositorySelection = {
- selected: "selected",
- all: "all",
+ selected: 'selected',
+ all: 'all',
} as const;
/**
* A GitHub App installation
*/
export interface GithubInstallation {
- /** The API URL for access tokens */
- access_tokens_url: string;
- account: GithubUser;
- /** The GitHub App ID */
- app_id: number;
- /** When the installation was created */
- created_at: string;
- /** The events the installation subscribes to */
- events: string[];
- /** The HTML URL of the installation */
- html_url: string;
- /** The installation ID */
- id: number;
- /** The installation permissions */
- permissions: GithubInstallationPermissions;
- /** The API URL for repositories */
- repositories_url: string;
- /** Repository selection for the installation */
- repository_selection: GithubInstallationRepositorySelection;
- /**
- * The single file name if applicable
- * @nullable
- */
- single_file_name?: string | null;
- /** The target ID */
- target_id: number;
- /** The target type */
- target_type: string;
- /** When the installation was last updated */
- updated_at: string;
+ /** The API URL for access tokens */
+ access_tokens_url: string;
+ account: GithubUser;
+ /** The GitHub App ID */
+ app_id: number;
+ /** When the installation was created */
+ created_at: string;
+ /** The events the installation subscribes to */
+ events: string[];
+ /** The HTML URL of the installation */
+ html_url: string;
+ /** The installation ID */
+ id: number;
+ /** The installation permissions */
+ permissions: GithubInstallationPermissions;
+ /** The API URL for repositories */
+ repositories_url: string;
+ /** Repository selection for the installation */
+ repository_selection: GithubInstallationRepositorySelection;
+ /**
+ * The single file name if applicable
+ * @nullable
+ */
+ single_file_name?: string | null;
+ /** The target ID */
+ target_id: number;
+ /** The target type */
+ target_type: string;
+ /** When the installation was last updated */
+ updated_at: string;
}
/**
* A GitHub organization
*/
export interface GithubOrganization {
- /** URL to the organization's avatar */
- avatar_url: string;
- /**
- * The organization description
- * @nullable
- */
- description?: string | null;
- /** The API URL of the organization's events */
- events_url: string;
- /** The API URL of the organization's hooks */
- hooks_url: string;
- /** The organization ID */
- id: number;
- /** The API URL of the organization's issues */
- issues_url: string;
- /** The organization's login name */
- login: string;
- /** The API URL of the organization's members */
- members_url: string;
- /** The organization node ID */
- node_id: string;
- /** The API URL of the organization's public members */
- public_members_url: string;
- /** The API URL of the organization's repositories */
- repos_url: string;
- /** The API URL of the organization */
- url: string;
+ /** URL to the organization's avatar */
+ avatar_url: string;
+ /**
+ * The organization description
+ * @nullable
+ */
+ description?: string | null;
+ /** The API URL of the organization's events */
+ events_url: string;
+ /** The API URL of the organization's hooks */
+ hooks_url: string;
+ /** The organization ID */
+ id: number;
+ /** The API URL of the organization's issues */
+ issues_url: string;
+ /** The organization's login name */
+ login: string;
+ /** The API URL of the organization's members */
+ members_url: string;
+ /** The organization node ID */
+ node_id: string;
+ /** The API URL of the organization's public members */
+ public_members_url: string;
+ /** The API URL of the organization's repositories */
+ repos_url: string;
+ /** The API URL of the organization */
+ url: string;
}
/**
* The state of the asset
*/
-export type GithubReleaseAssetState =
- (typeof GithubReleaseAssetState)[keyof typeof GithubReleaseAssetState];
+export type GithubReleaseAssetState = typeof GithubReleaseAssetState[keyof typeof GithubReleaseAssetState];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GithubReleaseAssetState = {
- uploaded: "uploaded",
- open: "open",
+ uploaded: 'uploaded',
+ open: 'open',
} as const;
/**
* A GitHub release asset
*/
export interface GithubReleaseAsset {
- /** The browser download URL */
- browser_download_url: string;
- /** The content type of the asset */
- content_type: string;
- /** When the asset was created */
- created_at: string;
- /** The number of downloads */
- download_count: number;
- /** The asset ID */
- id: number;
- /**
- * The label of the asset
- * @nullable
- */
- label?: string | null;
- /** The name of the asset */
- name: string;
- /** The asset node ID */
- node_id: string;
- /** The size of the asset in bytes */
- size: number;
- /** The state of the asset */
- state: GithubReleaseAssetState;
- /** When the asset was last updated */
- updated_at: string;
- uploader: GithubUser;
+ /** The browser download URL */
+ browser_download_url: string;
+ /** The content type of the asset */
+ content_type: string;
+ /** When the asset was created */
+ created_at: string;
+ /** The number of downloads */
+ download_count: number;
+ /** The asset ID */
+ id: number;
+ /**
+ * The label of the asset
+ * @nullable
+ */
+ label?: string | null;
+ /** The name of the asset */
+ name: string;
+ /** The asset node ID */
+ node_id: string;
+ /** The size of the asset in bytes */
+ size: number;
+ /** The state of the asset */
+ state: GithubReleaseAssetState;
+ /** When the asset was last updated */
+ updated_at: string;
+ uploader: GithubUser;
}
/**
* The action performed on the release
*/
-export type GithubReleaseWebhookAction =
- (typeof GithubReleaseWebhookAction)[keyof typeof GithubReleaseWebhookAction];
+export type GithubReleaseWebhookAction = typeof GithubReleaseWebhookAction[keyof typeof GithubReleaseWebhookAction];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GithubReleaseWebhookAction = {
- published: "published",
- unpublished: "unpublished",
- created: "created",
- edited: "edited",
- deleted: "deleted",
- prereleased: "prereleased",
- released: "released",
+ published: 'published',
+ unpublished: 'unpublished',
+ created: 'created',
+ edited: 'edited',
+ deleted: 'deleted',
+ prereleased: 'prereleased',
+ released: 'released',
} as const;
/**
* The release object
*/
export type GithubReleaseWebhookRelease = {
- /** Array of release assets */
- assets: GithubReleaseAsset[];
- /** The URL to the release assets */
- assets_url?: string;
- author: GithubUser;
- /**
- * The release notes/body
- * @nullable
- */
- body?: string | null;
- /** When the release was created */
- created_at: string;
- /** Whether the release is a draft */
- draft: boolean;
- /** The HTML URL of the release */
- html_url: string;
- /** The ID of the release */
- id: number;
- /**
- * The name of the release
- * @nullable
- */
- name?: string | null;
- /** The node ID of the release */
- node_id: string;
- /** Whether the release is a prerelease */
- prerelease: boolean;
- /**
- * When the release was published
- * @nullable
- */
- published_at?: string | null;
- /** The tag name of the release */
- tag_name: string;
- /** URL to the tarball */
- tarball_url: string;
- /** The branch or commit the release was created from */
- target_commitish: string;
- /** The URL to upload release assets */
- upload_url?: string;
- /** The API URL of the release */
- url: string;
- /** URL to the zipball */
- zipball_url: string;
+ /** Array of release assets */
+ assets: GithubReleaseAsset[];
+ /** The URL to the release assets */
+ assets_url?: string;
+ author: GithubUser;
+ /**
+ * The release notes/body
+ * @nullable
+ */
+ body?: string | null;
+ /** When the release was created */
+ created_at: string;
+ /** Whether the release is a draft */
+ draft: boolean;
+ /** The HTML URL of the release */
+ html_url: string;
+ /** The ID of the release */
+ id: number;
+ /**
+ * The name of the release
+ * @nullable
+ */
+ name?: string | null;
+ /** The node ID of the release */
+ node_id: string;
+ /** Whether the release is a prerelease */
+ prerelease: boolean;
+ /**
+ * When the release was published
+ * @nullable
+ */
+ published_at?: string | null;
+ /** The tag name of the release */
+ tag_name: string;
+ /** URL to the tarball */
+ tarball_url: string;
+ /** The branch or commit the release was created from */
+ target_commitish: string;
+ /** The URL to upload release assets */
+ upload_url?: string;
+ /** The API URL of the release */
+ url: string;
+ /** URL to the zipball */
+ zipball_url: string;
};
/**
* GitHub release webhook payload based on official webhook documentation
*/
export interface GithubReleaseWebhook {
- /** The action performed on the release */
- action: GithubReleaseWebhookAction;
- enterprise?: GithubEnterprise;
- installation?: GithubInstallation;
- organization?: GithubOrganization;
- /** The release object */
- release: GithubReleaseWebhookRelease;
- repository: GithubRepository;
- sender: GithubUser;
+ /** The action performed on the release */
+ action: GithubReleaseWebhookAction;
+ enterprise?: GithubEnterprise;
+ installation?: GithubInstallation;
+ organization?: GithubOrganization;
+ /** The release object */
+ release: GithubReleaseWebhookRelease;
+ repository: GithubRepository;
+ sender: GithubUser;
}
/**
* A GitHub repository
*/
export interface GithubRepository {
- /** The clone URL of the repository */
- clone_url: string;
- /** When the repository was created */
- created_at: string;
- /** The default branch of the repository */
- default_branch: string;
- /**
- * The repository description
- * @nullable
- */
- description?: string | null;
- /** Whether the repository is a fork */
- fork: boolean;
- /** The full name of the repository (owner/repo) */
- full_name: string;
- /** The git URL of the repository */
- git_url: string;
- /** The HTML URL of the repository */
- html_url: string;
- /** The repository ID */
- id: number;
- /** The name of the repository */
- name: string;
- /** The repository node ID */
- node_id: string;
- owner: GithubUser;
- /** Whether the repository is private */
- private: boolean;
- /** When the repository was last pushed to */
- pushed_at: string;
- /** The SSH URL of the repository */
- ssh_url: string;
- /** When the repository was last updated */
- updated_at: string;
- /** The API URL of the repository */
- url: string;
+ /** The clone URL of the repository */
+ clone_url: string;
+ /** When the repository was created */
+ created_at: string;
+ /** The default branch of the repository */
+ default_branch: string;
+ /**
+ * The repository description
+ * @nullable
+ */
+ description?: string | null;
+ /** Whether the repository is a fork */
+ fork: boolean;
+ /** The full name of the repository (owner/repo) */
+ full_name: string;
+ /** The git URL of the repository */
+ git_url: string;
+ /** The HTML URL of the repository */
+ html_url: string;
+ /** The repository ID */
+ id: number;
+ /** The name of the repository */
+ name: string;
+ /** The repository node ID */
+ node_id: string;
+ owner: GithubUser;
+ /** Whether the repository is private */
+ private: boolean;
+ /** When the repository was last pushed to */
+ pushed_at: string;
+ /** The SSH URL of the repository */
+ ssh_url: string;
+ /** When the repository was last updated */
+ updated_at: string;
+ /** The API URL of the repository */
+ url: string;
}
/**
* The type of user
*/
-export type GithubUserType =
- (typeof GithubUserType)[keyof typeof GithubUserType];
+export type GithubUserType = typeof GithubUserType[keyof typeof GithubUserType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GithubUserType = {
- Bot: "Bot",
- User: "User",
- Organization: "Organization",
+ Bot: 'Bot',
+ User: 'User',
+ Organization: 'Organization',
} as const;
/**
* A GitHub user
*/
export interface GithubUser {
- /** URL to the user's avatar */
- avatar_url: string;
- /**
- * The user's gravatar ID
- * @nullable
- */
- gravatar_id?: string | null;
- /** The HTML URL of the user */
- html_url: string;
- /** The user's ID */
- id: number;
- /** The user's login name */
- login: string;
- /** The user's node ID */
- node_id: string;
- /** Whether the user is a site admin */
- site_admin: boolean;
- /** The type of user */
- type: GithubUserType;
- /** The API URL of the user */
- url: string;
+ /** URL to the user's avatar */
+ avatar_url: string;
+ /**
+ * The user's gravatar ID
+ * @nullable
+ */
+ gravatar_id?: string | null;
+ /** The HTML URL of the user */
+ html_url: string;
+ /** The user's ID */
+ id: number;
+ /** The user's login name */
+ login: string;
+ /** The user's node ID */
+ node_id: string;
+ /** Whether the user is a site admin */
+ site_admin: boolean;
+ /** The type of user */
+ type: GithubUserType;
+ /** The API URL of the user */
+ url: string;
}
export type IdeogramColorPaletteOneOf = {
- /** Name of the preset color palette */
- name: string;
+ /** Name of the preset color palette */
+ name: string;
};
export type IdeogramColorPaletteOneOfTwoMembersItem = {
- /**
- * Hexadecimal color code
- * @pattern ^#[0-9A-Fa-f]{6}$
- */
- color?: string;
- /**
- * Optional weight for the color (0-1)
- * @minimum 0
- * @maximum 1
- */
- weight?: number;
+ /**
+ * Hexadecimal color code
+ * @pattern ^#[0-9A-Fa-f]{6}$
+ */
+ color?: string;
+ /**
+ * Optional weight for the color (0-1)
+ * @minimum 0
+ * @maximum 1
+ */
+ weight?: number;
};
export type IdeogramColorPaletteOneOfTwo = {
- /** Array of color definitions with optional weights */
- members: IdeogramColorPaletteOneOfTwoMembersItem[];
+ /** Array of color definitions with optional weights */
+ members: IdeogramColorPaletteOneOfTwoMembersItem[];
};
/**
* A color palette specification that can either use a preset name or explicit color definitions with weights
*/
-export type IdeogramColorPalette =
- | IdeogramColorPaletteOneOf
- | IdeogramColorPaletteOneOfTwo;
+export type IdeogramColorPalette = IdeogramColorPaletteOneOf | IdeogramColorPaletteOneOfTwo;
/**
* Optional. Color palette object. Only for V_2, V_2_TURBO.
*/
-export type IdeogramGenerateRequestImageRequestColorPalette = {
- [key: string]: unknown;
-};
+export type IdeogramGenerateRequestImageRequestColorPalette = { [key: string]: unknown };
/**
* The image generation request parameters.
*/
export type IdeogramGenerateRequestImageRequest = {
- /** Optional. The aspect ratio (e.g., 'ASPECT_16_9', 'ASPECT_1_1'). Cannot be used with resolution. Defaults to 'ASPECT_1_1' if unspecified. */
- aspect_ratio?: string;
- /** Optional. Color palette object. Only for V_2, V_2_TURBO. */
- color_palette?: IdeogramGenerateRequestImageRequestColorPalette;
- /** Optional. MagicPrompt usage ('AUTO', 'ON', 'OFF'). */
- magic_prompt_option?: string;
- /** The model used (e.g., 'V_2', 'V_2A_TURBO') */
- model: string;
- /** Optional. Description of what to exclude. Only for V_1, V_1_TURBO, V_2, V_2_TURBO. */
- negative_prompt?: string;
- /**
- * Optional. Number of images to generate (1-8). Defaults to 1.
- * @minimum 1
- * @maximum 8
- */
- num_images?: number;
- /** Required. The prompt to use to generate the image. */
- prompt: string;
- /** Optional. Resolution (e.g., 'RESOLUTION_1024_1024'). Only for model V_2. Cannot be used with aspect_ratio. */
- resolution?: string;
- /**
- * Optional. A number between 0 and 2147483647.
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- /** Optional. Style type ('AUTO', 'GENERAL', 'REALISTIC', 'DESIGN', 'RENDER_3D', 'ANIME'). Only for models V_2 and above. */
- style_type?: string;
+ /** Optional. The aspect ratio (e.g., 'ASPECT_16_9', 'ASPECT_1_1'). Cannot be used with resolution. Defaults to 'ASPECT_1_1' if unspecified. */
+ aspect_ratio?: string;
+ /** Optional. Color palette object. Only for V_2, V_2_TURBO. */
+ color_palette?: IdeogramGenerateRequestImageRequestColorPalette;
+ /** Optional. MagicPrompt usage ('AUTO', 'ON', 'OFF'). */
+ magic_prompt_option?: string;
+ /** The model used (e.g., 'V_2', 'V_2A_TURBO') */
+ model: string;
+ /** Optional. Description of what to exclude. Only for V_1, V_1_TURBO, V_2, V_2_TURBO. */
+ negative_prompt?: string;
+ /**
+ * Optional. Number of images to generate (1-8). Defaults to 1.
+ * @minimum 1
+ * @maximum 8
+ */
+ num_images?: number;
+ /** Required. The prompt to use to generate the image. */
+ prompt: string;
+ /** Optional. Resolution (e.g., 'RESOLUTION_1024_1024'). Only for model V_2. Cannot be used with aspect_ratio. */
+ resolution?: string;
+ /**
+ * Optional. A number between 0 and 2147483647.
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ /** Optional. Style type ('AUTO', 'GENERAL', 'REALISTIC', 'DESIGN', 'RENDER_3D', 'ANIME'). Only for models V_2 and above. */
+ style_type?: string;
};
/**
* Parameters for the Ideogram generation proxy request. Based on Ideogram's API.
*/
export interface IdeogramGenerateRequest {
- /** The image generation request parameters. */
- image_request: IdeogramGenerateRequestImageRequest;
+ /** The image generation request parameters. */
+ image_request: IdeogramGenerateRequestImageRequest;
}
export type IdeogramGenerateResponseDataItem = {
- /** Indicates whether the image is considered safe. */
- is_image_safe?: boolean;
- /** The prompt used to generate this image. */
- prompt?: string;
- /** The resolution of the generated image (e.g., '1024x1024'). */
- resolution?: string;
- /** The seed value used for this generation. */
- seed?: number;
- /** The style type used for generation (e.g., 'REALISTIC', 'ANIME'). */
- style_type?: string;
- /** URL to the generated image. */
- url?: string;
+ /** Indicates whether the image is considered safe. */
+ is_image_safe?: boolean;
+ /** The prompt used to generate this image. */
+ prompt?: string;
+ /** The resolution of the generated image (e.g., '1024x1024'). */
+ resolution?: string;
+ /** The seed value used for this generation. */
+ seed?: number;
+ /** The style type used for generation (e.g., 'REALISTIC', 'ANIME'). */
+ style_type?: string;
+ /** URL to the generated image. */
+ url?: string;
};
/**
* Response from the Ideogram image generation API.
*/
export interface IdeogramGenerateResponse {
- /** Timestamp when the generation was created. */
- created?: string;
- /** Array of generated image information. */
- data?: IdeogramGenerateResponseDataItem[];
+ /** Timestamp when the generation was created. */
+ created?: string;
+ /** Array of generated image information. */
+ data?: IdeogramGenerateResponseDataItem[];
}
-export type IdeogramStyleType =
- (typeof IdeogramStyleType)[keyof typeof IdeogramStyleType];
+export type IdeogramStyleType = typeof IdeogramStyleType[keyof typeof IdeogramStyleType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const IdeogramStyleType = {
- AUTO: "AUTO",
- GENERAL: "GENERAL",
- REALISTIC: "REALISTIC",
- DESIGN: "DESIGN",
- FICTION: "FICTION",
+ AUTO: 'AUTO',
+ GENERAL: 'GENERAL',
+ REALISTIC: 'REALISTIC',
+ DESIGN: 'DESIGN',
+ FICTION: 'FICTION',
} as const;
export interface IdeogramV3EditRequest {
- /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images?: Blob[];
- /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images_mask?: Blob[];
- color_palette?: IdeogramColorPalette;
- /** The image being edited (max size 10MB); only JPEG, WebP and PNG formats are supported at this time. */
- image?: Blob;
- /** Determine if MagicPrompt should be used in generating the request or not. */
- magic_prompt?: string;
- /** A black and white image of the same size as the image being edited (max size 10MB). Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time. */
- mask?: Blob;
- /** The number of images to generate. */
- num_images?: number;
- /** The prompt used to describe the edited result. */
- prompt: string;
- rendering_speed: RenderingSpeed;
- /** Random seed. Set for reproducible generation. */
- seed?: number;
- /** A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type. */
- style_codes?: string[];
- /** A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format. */
- style_reference_images?: Blob[];
- style_type?: IdeogramStyleType;
+ /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images?: Blob[];
+ /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images_mask?: Blob[];
+ color_palette?: IdeogramColorPalette;
+ /** The image being edited (max size 10MB); only JPEG, WebP and PNG formats are supported at this time. */
+ image?: Blob;
+ /** Determine if MagicPrompt should be used in generating the request or not. */
+ magic_prompt?: string;
+ /** A black and white image of the same size as the image being edited (max size 10MB). Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time. */
+ mask?: Blob;
+ /** The number of images to generate. */
+ num_images?: number;
+ /** The prompt used to describe the edited result. */
+ prompt: string;
+ rendering_speed: RenderingSpeed;
+ /** Random seed. Set for reproducible generation. */
+ seed?: number;
+ /** A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type. */
+ style_codes?: string[];
+ /** A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format. */
+ style_reference_images?: Blob[];
+ style_type?: IdeogramStyleType;
}
export type IdeogramV3IdeogramResponseDataItem = {
- is_image_safe?: boolean;
- prompt?: string;
- resolution?: string;
- seed?: number;
- style_type?: string;
- url?: string;
+ is_image_safe?: boolean;
+ prompt?: string;
+ resolution?: string;
+ seed?: number;
+ style_type?: string;
+ url?: string;
};
export interface IdeogramV3IdeogramResponse {
- created?: string;
- data?: IdeogramV3IdeogramResponseDataItem[];
+ created?: string;
+ data?: IdeogramV3IdeogramResponseDataItem[];
}
export type IdeogramV3ReframeRequestColorPalette = { [key: string]: unknown };
export interface IdeogramV3ReframeRequest {
- color_palette?: IdeogramV3ReframeRequestColorPalette;
- image?: Blob;
- /**
- * @minimum 1
- * @maximum 8
- */
- num_images?: number;
- rendering_speed?: RenderingSpeed;
- resolution: string;
- /**
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- style_codes?: string[];
- style_reference_images?: Blob[];
+ color_palette?: IdeogramV3ReframeRequestColorPalette;
+ image?: Blob;
+ /**
+ * @minimum 1
+ * @maximum 8
+ */
+ num_images?: number;
+ rendering_speed?: RenderingSpeed;
+ resolution: string;
+ /**
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ style_codes?: string[];
+ style_reference_images?: Blob[];
}
export type IdeogramV3RemixRequestColorPalette = { [key: string]: unknown };
-export type IdeogramV3RemixRequestMagicPrompt =
- (typeof IdeogramV3RemixRequestMagicPrompt)[keyof typeof IdeogramV3RemixRequestMagicPrompt];
+export type IdeogramV3RemixRequestMagicPrompt = typeof IdeogramV3RemixRequestMagicPrompt[keyof typeof IdeogramV3RemixRequestMagicPrompt];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const IdeogramV3RemixRequestMagicPrompt = {
- AUTO: "AUTO",
- ON: "ON",
- OFF: "OFF",
+ AUTO: 'AUTO',
+ ON: 'ON',
+ OFF: 'OFF',
} as const;
export interface IdeogramV3RemixRequest {
- aspect_ratio?: string;
- /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images?: Blob[];
- /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images_mask?: Blob[];
- color_palette?: IdeogramV3RemixRequestColorPalette;
- image?: Blob;
- /**
- * @minimum 1
- * @maximum 100
- */
- image_weight?: number;
- magic_prompt?: IdeogramV3RemixRequestMagicPrompt;
- negative_prompt?: string;
- /**
- * @minimum 1
- * @maximum 8
- */
- num_images?: number;
- prompt: string;
- rendering_speed?: RenderingSpeed;
- resolution?: string;
- /**
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- style_codes?: string[];
- style_reference_images?: Blob[];
- style_type?: IdeogramStyleType;
+ aspect_ratio?: string;
+ /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images?: Blob[];
+ /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images_mask?: Blob[];
+ color_palette?: IdeogramV3RemixRequestColorPalette;
+ image?: Blob;
+ /**
+ * @minimum 1
+ * @maximum 100
+ */
+ image_weight?: number;
+ magic_prompt?: IdeogramV3RemixRequestMagicPrompt;
+ negative_prompt?: string;
+ /**
+ * @minimum 1
+ * @maximum 8
+ */
+ num_images?: number;
+ prompt: string;
+ rendering_speed?: RenderingSpeed;
+ resolution?: string;
+ /**
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ style_codes?: string[];
+ style_reference_images?: Blob[];
+ style_type?: IdeogramStyleType;
}
-export type IdeogramV3ReplaceBackgroundRequestColorPalette = {
- [key: string]: unknown;
-};
+export type IdeogramV3ReplaceBackgroundRequestColorPalette = { [key: string]: unknown };
+
+export type IdeogramV3ReplaceBackgroundRequestMagicPrompt = typeof IdeogramV3ReplaceBackgroundRequestMagicPrompt[keyof typeof IdeogramV3ReplaceBackgroundRequestMagicPrompt];
-export type IdeogramV3ReplaceBackgroundRequestMagicPrompt =
- (typeof IdeogramV3ReplaceBackgroundRequestMagicPrompt)[keyof typeof IdeogramV3ReplaceBackgroundRequestMagicPrompt];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const IdeogramV3ReplaceBackgroundRequestMagicPrompt = {
- AUTO: "AUTO",
- ON: "ON",
- OFF: "OFF",
+ AUTO: 'AUTO',
+ ON: 'ON',
+ OFF: 'OFF',
} as const;
export interface IdeogramV3ReplaceBackgroundRequest {
- color_palette?: IdeogramV3ReplaceBackgroundRequestColorPalette;
- image?: Blob;
- magic_prompt?: IdeogramV3ReplaceBackgroundRequestMagicPrompt;
- /**
- * @minimum 1
- * @maximum 8
- */
- num_images?: number;
- prompt: string;
- rendering_speed?: RenderingSpeed;
- /**
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- style_codes?: string[];
- style_reference_images?: Blob[];
+ color_palette?: IdeogramV3ReplaceBackgroundRequestColorPalette;
+ image?: Blob;
+ magic_prompt?: IdeogramV3ReplaceBackgroundRequestMagicPrompt;
+ /**
+ * @minimum 1
+ * @maximum 8
+ */
+ num_images?: number;
+ prompt: string;
+ rendering_speed?: RenderingSpeed;
+ /**
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ style_codes?: string[];
+ style_reference_images?: Blob[];
}
export type IdeogramV3RequestColorPalette = {
- /** Name of the color palette */
- name: string;
+ /** Name of the color palette */
+ name: string;
};
/**
* Whether to enable magic prompt enhancement
*/
-export type IdeogramV3RequestMagicPrompt =
- (typeof IdeogramV3RequestMagicPrompt)[keyof typeof IdeogramV3RequestMagicPrompt];
+export type IdeogramV3RequestMagicPrompt = typeof IdeogramV3RequestMagicPrompt[keyof typeof IdeogramV3RequestMagicPrompt];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const IdeogramV3RequestMagicPrompt = {
- ON: "ON",
- OFF: "OFF",
+ ON: 'ON',
+ OFF: 'OFF',
} as const;
export interface IdeogramV3Request {
- /** Aspect ratio in format WxH */
- aspect_ratio?: string;
- /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images?: Blob[];
- /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
- character_reference_images_mask?: Blob[];
- color_palette?: IdeogramV3RequestColorPalette;
- /** Whether to enable magic prompt enhancement */
- magic_prompt?: IdeogramV3RequestMagicPrompt;
- /** Text prompt specifying what to avoid in the generation */
- negative_prompt?: string;
- /**
- * Number of images to generate
- * @minimum 1
- */
- num_images?: number;
- /** The text prompt for image generation */
- prompt: string;
- rendering_speed: RenderingSpeed;
- /** Image resolution in format WxH */
- resolution?: string;
- /** Seed value for reproducible generation */
- seed?: number;
- /** Array of style codes in hexadecimal format */
- style_codes?: string[];
- /** Array of reference image URLs or identifiers */
- style_reference_images?: Blob[];
- style_type?: IdeogramStyleType;
+ /** Aspect ratio in format WxH */
+ aspect_ratio?: string;
+ /** Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images?: Blob[];
+ /** Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format. */
+ character_reference_images_mask?: Blob[];
+ color_palette?: IdeogramV3RequestColorPalette;
+ /** Whether to enable magic prompt enhancement */
+ magic_prompt?: IdeogramV3RequestMagicPrompt;
+ /** Text prompt specifying what to avoid in the generation */
+ negative_prompt?: string;
+ /**
+ * Number of images to generate
+ * @minimum 1
+ */
+ num_images?: number;
+ /** The text prompt for image generation */
+ prompt: string;
+ rendering_speed: RenderingSpeed;
+ /** Image resolution in format WxH */
+ resolution?: string;
+ /** Seed value for reproducible generation */
+ seed?: number;
+ /** Array of style codes in hexadecimal format */
+ style_codes?: string[];
+ /** Array of reference image URLs or identifiers */
+ style_reference_images?: Blob[];
+ style_type?: IdeogramStyleType;
}
export interface ImagenGenerateImageRequest {
- instances: ImagenImageGenerationInstance[];
- parameters: ImagenImageGenerationParameters;
+ instances: ImagenImageGenerationInstance[];
+ parameters: ImagenImageGenerationParameters;
}
export interface ImagenGenerateImageResponse {
- predictions?: ImagenImagePrediction[];
+ predictions?: ImagenImagePrediction[];
}
export interface ImagenImageGenerationInstance {
- /** Text prompt for image generation */
- prompt: string;
+ /** Text prompt for image generation */
+ prompt: string;
}
-export type ImagenImageGenerationParametersAspectRatio =
- (typeof ImagenImageGenerationParametersAspectRatio)[keyof typeof ImagenImageGenerationParametersAspectRatio];
+export type ImagenImageGenerationParametersAspectRatio = typeof ImagenImageGenerationParametersAspectRatio[keyof typeof ImagenImageGenerationParametersAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ImagenImageGenerationParametersAspectRatio = {
- "1:1": "1:1",
- "9:16": "9:16",
- "16:9": "16:9",
- "3:4": "3:4",
- "4:3": "4:3",
+ '1:1': '1:1',
+ '9:16': '9:16',
+ '16:9': '16:9',
+ '3:4': '3:4',
+ '4:3': '4:3',
} as const;
-export type ImagenImageGenerationParametersPersonGeneration =
- (typeof ImagenImageGenerationParametersPersonGeneration)[keyof typeof ImagenImageGenerationParametersPersonGeneration];
+export type ImagenImageGenerationParametersPersonGeneration = typeof ImagenImageGenerationParametersPersonGeneration[keyof typeof ImagenImageGenerationParametersPersonGeneration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ImagenImageGenerationParametersPersonGeneration = {
- dont_allow: "dont_allow",
- allow_adult: "allow_adult",
- allow_all: "allow_all",
+ dont_allow: 'dont_allow',
+ allow_adult: 'allow_adult',
+ allow_all: 'allow_all',
} as const;
-export type ImagenImageGenerationParametersSafetySetting =
- (typeof ImagenImageGenerationParametersSafetySetting)[keyof typeof ImagenImageGenerationParametersSafetySetting];
+export type ImagenImageGenerationParametersSafetySetting = typeof ImagenImageGenerationParametersSafetySetting[keyof typeof ImagenImageGenerationParametersSafetySetting];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ImagenImageGenerationParametersSafetySetting = {
- block_most: "block_most",
- block_some: "block_some",
- block_few: "block_few",
- block_fewest: "block_fewest",
+ block_most: 'block_most',
+ block_some: 'block_some',
+ block_few: 'block_few',
+ block_fewest: 'block_fewest',
} as const;
export interface ImagenImageGenerationParameters {
- addWatermark?: boolean;
- aspectRatio?: ImagenImageGenerationParametersAspectRatio;
- enhancePrompt?: boolean;
- includeRaiReason?: boolean;
- includeSafetyAttributes?: boolean;
- outputOptions?: ImagenOutputOptions;
- personGeneration?: ImagenImageGenerationParametersPersonGeneration;
- safetySetting?: ImagenImageGenerationParametersSafetySetting;
- /**
- * @minimum 1
- * @maximum 4
- */
- sampleCount?: number;
- seed?: number;
- storageUri?: string;
+ addWatermark?: boolean;
+ aspectRatio?: ImagenImageGenerationParametersAspectRatio;
+ enhancePrompt?: boolean;
+ includeRaiReason?: boolean;
+ includeSafetyAttributes?: boolean;
+ outputOptions?: ImagenOutputOptions;
+ personGeneration?: ImagenImageGenerationParametersPersonGeneration;
+ safetySetting?: ImagenImageGenerationParametersSafetySetting;
+ /**
+ * @minimum 1
+ * @maximum 4
+ */
+ sampleCount?: number;
+ seed?: number;
+ storageUri?: string;
}
export interface ImagenImagePrediction {
- /** Base64-encoded image content */
- bytesBase64Encoded?: string;
- /** MIME type of the generated image */
- mimeType?: string;
- /** Enhanced or rewritten prompt used to generate this image */
- prompt?: string;
+ /** Base64-encoded image content */
+ bytesBase64Encoded?: string;
+ /** MIME type of the generated image */
+ mimeType?: string;
+ /** Enhanced or rewritten prompt used to generate this image */
+ prompt?: string;
}
-export type ImagenOutputOptionsMimeType =
- (typeof ImagenOutputOptionsMimeType)[keyof typeof ImagenOutputOptionsMimeType];
+export type ImagenOutputOptionsMimeType = typeof ImagenOutputOptionsMimeType[keyof typeof ImagenOutputOptionsMimeType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ImagenOutputOptionsMimeType = {
- "image/png": "image/png",
- "image/jpeg": "image/jpeg",
+ 'image/png': 'image/png',
+ 'image/jpeg': 'image/jpeg',
} as const;
export interface ImagenOutputOptions {
- /**
- * @minimum 0
- * @maximum 100
- */
- compressionQuality?: number;
- mimeType?: ImagenOutputOptionsMimeType;
+ /**
+ * @minimum 0
+ * @maximum 100
+ */
+ compressionQuality?: number;
+ mimeType?: ImagenOutputOptionsMimeType;
}
/**
@@ -2172,120 +2213,117 @@ supported values are:
- `computer_call_output.output.image_url`: Include image urls from the computer call output.
*/
-export type Includable = (typeof Includable)[keyof typeof Includable];
+export type Includable = typeof Includable[keyof typeof Includable];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Includable = {
- file_search_callresults: "file_search_call.results",
- messageinput_imageimage_url: "message.input_image.image_url",
- computer_call_outputoutputimage_url:
- "computer_call_output.output.image_url",
+ file_search_callresults: 'file_search_call.results',
+ messageinput_imageimage_url: 'message.input_image.image_url',
+ computer_call_outputoutputimage_url: 'computer_call_output.output.image_url',
} as const;
-export type InputContent =
- | InputTextContent
- | InputImageContent
- | InputFileContent;
+export type InputContent = InputTextContent | InputImageContent | InputFileContent;
/**
* The type of the input item. Always `input_file`.
*/
-export type InputFileContentType =
- (typeof InputFileContentType)[keyof typeof InputFileContentType];
+export type InputFileContentType = typeof InputFileContentType[keyof typeof InputFileContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputFileContentType = {
- input_file: "input_file",
+ input_file: 'input_file',
} as const;
/**
* A file input to the model.
*/
export interface InputFileContent {
- /** The content of the file to be sent to the model.
- */
- file_data?: string;
- /** The ID of the file to be sent to the model. */
- file_id?: string;
- /** The name of the file to be sent to the model. */
- filename?: string;
- /** The type of the input item. Always `input_file`. */
- type: InputFileContentType;
+ /** The content of the file to be sent to the model.
+ */
+ file_data?: string;
+ /** The ID of the file to be sent to the model. */
+ file_id?: string;
+ /** The name of the file to be sent to the model. */
+ filename?: string;
+ /** The type of the input item. Always `input_file`. */
+ type: InputFileContentType;
}
/**
* The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.
*/
-export type InputImageContentDetail =
- (typeof InputImageContentDetail)[keyof typeof InputImageContentDetail];
+export type InputImageContentDetail = typeof InputImageContentDetail[keyof typeof InputImageContentDetail];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputImageContentDetail = {
- low: "low",
- high: "high",
- auto: "auto",
+ low: 'low',
+ high: 'high',
+ auto: 'auto',
} as const;
/**
* The type of the input item. Always `input_image`.
*/
-export type InputImageContentType =
- (typeof InputImageContentType)[keyof typeof InputImageContentType];
+export type InputImageContentType = typeof InputImageContentType[keyof typeof InputImageContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputImageContentType = {
- input_image: "input_image",
+ input_image: 'input_image',
} as const;
/**
* An image input to the model. Learn about [image inputs](/docs/guides/vision).
*/
export interface InputImageContent {
- /** The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. */
- detail: InputImageContentDetail;
- /** The ID of the file to be sent to the model. */
- file_id?: string;
- /** The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. */
- image_url?: string;
- /** The type of the input item. Always `input_image`. */
- type: InputImageContentType;
+ /** The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. */
+ detail: InputImageContentDetail;
+ /** The ID of the file to be sent to the model. */
+ file_id?: string;
+ /** The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. */
+ image_url?: string;
+ /** The type of the input item. Always `input_image`. */
+ type: InputImageContentType;
}
export type InputItem = EasyInputMessage | Item;
-export type InputMessageRole =
- (typeof InputMessageRole)[keyof typeof InputMessageRole];
+export type InputMessageRole = typeof InputMessageRole[keyof typeof InputMessageRole];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputMessageRole = {
- user: "user",
- system: "system",
- developer: "developer",
+ user: 'user',
+ system: 'system',
+ developer: 'developer',
} as const;
-export type InputMessageStatus =
- (typeof InputMessageStatus)[keyof typeof InputMessageStatus];
+export type InputMessageStatus = typeof InputMessageStatus[keyof typeof InputMessageStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputMessageStatus = {
- in_progress: "in_progress",
- completed: "completed",
- incomplete: "incomplete",
+ in_progress: 'in_progress',
+ completed: 'completed',
+ incomplete: 'incomplete',
} as const;
-export type InputMessageType =
- (typeof InputMessageType)[keyof typeof InputMessageType];
+export type InputMessageType = typeof InputMessageType[keyof typeof InputMessageType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputMessageType = {
- message: "message",
+ message: 'message',
} as const;
export interface InputMessage {
- content?: InputMessageContentList;
- role?: InputMessageRole;
- status?: InputMessageStatus;
- type?: InputMessageType;
+ content?: InputMessageContentList;
+ role?: InputMessageRole;
+ status?: InputMessageStatus;
+ type?: InputMessageType;
}
/**
@@ -2298,139 +2336,132 @@ export type InputMessageContentList = InputContent[];
/**
* The type of the input item. Always `input_text`.
*/
-export type InputTextContentType =
- (typeof InputTextContentType)[keyof typeof InputTextContentType];
+export type InputTextContentType = typeof InputTextContentType[keyof typeof InputTextContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const InputTextContentType = {
- input_text: "input_text",
+ input_text: 'input_text',
} as const;
/**
* A text input to the model.
*/
export interface InputTextContent {
- /** The text input to the model. */
- text: string;
- /** The type of the input item. Always `input_text`. */
- type: InputTextContentType;
+ /** The text input to the model. */
+ text: string;
+ /** The type of the input item. Always `input_text`. */
+ type: InputTextContentType;
}
/**
* Content item used to generate a response.
*/
-export type Item =
- | InputMessage
- | OutputMessage
- | FileSearchToolCall
- | ComputerToolCall
- | WebSearchToolCall
- | FunctionToolCall
- | ReasoningItem;
+export type Item = InputMessage | OutputMessage | FileSearchToolCall | ComputerToolCall | WebSearchToolCall | FunctionToolCall | ReasoningItem;
/**
* Method of Transmitting Audio Files for Lip-Sync. Required when mode is audio2video.
*/
-export type KlingAudioUploadType =
- (typeof KlingAudioUploadType)[keyof typeof KlingAudioUploadType];
+export type KlingAudioUploadType = typeof KlingAudioUploadType[keyof typeof KlingAudioUploadType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingAudioUploadType = {
- file: "file",
- url: "url",
+ file: 'file',
+ url: 'url',
} as const;
export interface KlingCameraConfig {
- /**
- * Controls camera's movement along horizontal axis (x-axis). Negative indicates left, positive indicates right.
- * @minimum -10
- * @maximum 10
- */
- horizontal?: number;
- /**
- * Controls camera's rotation in vertical plane (x-axis). Negative indicates downward rotation, positive indicates upward rotation.
- * @minimum -10
- * @maximum 10
- */
- pan?: number;
- /**
- * Controls camera's rolling amount (z-axis). Negative indicates counterclockwise, positive indicates clockwise.
- * @minimum -10
- * @maximum 10
- */
- roll?: number;
- /**
- * Controls camera's rotation in horizontal plane (y-axis). Negative indicates left rotation, positive indicates right rotation.
- * @minimum -10
- * @maximum 10
- */
- tilt?: number;
- /**
- * Controls camera's movement along vertical axis (y-axis). Negative indicates downward, positive indicates upward.
- * @minimum -10
- * @maximum 10
- */
- vertical?: number;
- /**
- * Controls change in camera's focal length. Negative indicates narrower field of view, positive indicates wider field of view.
- * @minimum -10
- * @maximum 10
- */
- zoom?: number;
+ /**
+ * Controls camera's movement along horizontal axis (x-axis). Negative indicates left, positive indicates right.
+ * @minimum -10
+ * @maximum 10
+ */
+ horizontal?: number;
+ /**
+ * Controls camera's rotation in vertical plane (x-axis). Negative indicates downward rotation, positive indicates upward rotation.
+ * @minimum -10
+ * @maximum 10
+ */
+ pan?: number;
+ /**
+ * Controls camera's rolling amount (z-axis). Negative indicates counterclockwise, positive indicates clockwise.
+ * @minimum -10
+ * @maximum 10
+ */
+ roll?: number;
+ /**
+ * Controls camera's rotation in horizontal plane (y-axis). Negative indicates left rotation, positive indicates right rotation.
+ * @minimum -10
+ * @maximum 10
+ */
+ tilt?: number;
+ /**
+ * Controls camera's movement along vertical axis (y-axis). Negative indicates downward, positive indicates upward.
+ * @minimum -10
+ * @maximum 10
+ */
+ vertical?: number;
+ /**
+ * Controls change in camera's focal length. Negative indicates narrower field of view, positive indicates wider field of view.
+ * @minimum -10
+ * @maximum 10
+ */
+ zoom?: number;
}
export interface KlingCameraControl {
- config?: KlingCameraConfig;
- type?: KlingCameraControlType;
+ config?: KlingCameraConfig;
+ type?: KlingCameraControlType;
}
/**
* Predefined camera movements type. simple: Customizable camera movement. down_back: Camera descends and moves backward. forward_up: Camera moves forward and tilts up. right_turn_forward: Rotate right and move forward. left_turn_forward: Rotate left and move forward.
*/
-export type KlingCameraControlType =
- (typeof KlingCameraControlType)[keyof typeof KlingCameraControlType];
+export type KlingCameraControlType = typeof KlingCameraControlType[keyof typeof KlingCameraControlType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingCameraControlType = {
- simple: "simple",
- down_back: "down_back",
- forward_up: "forward_up",
- right_turn_forward: "right_turn_forward",
- left_turn_forward: "left_turn_forward",
+ simple: 'simple',
+ down_back: 'down_back',
+ forward_up: 'forward_up',
+ right_turn_forward: 'right_turn_forward',
+ left_turn_forward: 'left_turn_forward',
} as const;
/**
* Model Name. Can be kling-v1, kling-v1-5, or kling-v1-6.
*/
-export type KlingCharacterEffectModelName =
- (typeof KlingCharacterEffectModelName)[keyof typeof KlingCharacterEffectModelName];
+export type KlingCharacterEffectModelName = typeof KlingCharacterEffectModelName[keyof typeof KlingCharacterEffectModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingCharacterEffectModelName = {
- "kling-v1": "kling-v1",
- "kling-v1-5": "kling-v1-5",
- "kling-v1-6": "kling-v1-6",
+ 'kling-v1': 'kling-v1',
+ 'kling-v1-5': 'kling-v1-5',
+ 'kling-v1-6': 'kling-v1-6',
} as const;
export interface KlingDualCharacterEffectInput {
- duration: KlingVideoGenDuration;
- images: KlingDualCharacterImages;
- mode?: KlingVideoGenMode;
- model_name?: KlingCharacterEffectModelName;
+ duration: KlingVideoGenDuration;
+ images: KlingDualCharacterImages;
+ mode?: KlingVideoGenMode;
+ model_name?: KlingCharacterEffectModelName;
}
/**
* Scene Name. Dual-character Effects (hug, kiss, heart_gesture).
*/
-export type KlingDualCharacterEffectsScene =
- (typeof KlingDualCharacterEffectsScene)[keyof typeof KlingDualCharacterEffectsScene];
+export type KlingDualCharacterEffectsScene = typeof KlingDualCharacterEffectsScene[keyof typeof KlingDualCharacterEffectsScene];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingDualCharacterEffectsScene = {
- hug: "hug",
- kiss: "kiss",
- heart_gesture: "heart_gesture",
+ hug: 'hug',
+ kiss: 'kiss',
+ heart_gesture: 'heart_gesture',
} as const;
/**
@@ -2440,7 +2471,7 @@ export const KlingDualCharacterEffectsScene = {
export type KlingDualCharacterImages = string[];
export interface KlingErrorResponse {
- /** - 1000: Authentication failed
+ /** - 1000: Authentication failed
- 1001: Authorization is empty
- 1002: Authorization is invalid
- 1003: Authorization is not yet valid
@@ -2462,587 +2493,581 @@ export interface KlingErrorResponse {
- 5001: Service temporarily unavailable
- 5002: Server internal timeout
*/
- code: number;
- /** Human-readable error message */
- message: string;
- /** Request ID for tracking and troubleshooting */
- request_id: string;
+ code: number;
+ /** Human-readable error message */
+ message: string;
+ /** Request ID for tracking and troubleshooting */
+ request_id: string;
}
export type KlingImage2VideoRequestDynamicMasksItemTrajectoriesItem = {
- /** The horizontal coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0). */
- x?: number;
- /** The vertical coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0). */
- y?: number;
+ /** The horizontal coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0). */
+ x?: number;
+ /** The vertical coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0). */
+ y?: number;
};
export type KlingImage2VideoRequestDynamicMasksItem = {
- /** Dynamic Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image. */
- mask?: string;
- trajectories?: KlingImage2VideoRequestDynamicMasksItemTrajectoriesItem[];
+ /** Dynamic Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image. */
+ mask?: string;
+ trajectories?: KlingImage2VideoRequestDynamicMasksItemTrajectoriesItem[];
};
export interface KlingImage2VideoRequest {
- aspect_ratio?: KlingVideoGenAspectRatio;
- /** The callback notification address. Server will notify when the task status changes. */
- callback_url?: string;
- camera_control?: KlingCameraControl;
- cfg_scale?: KlingVideoGenCfgScale;
- duration?: KlingVideoGenDuration;
- /** Dynamic Brush Configuration List (up to 6 groups). For 5-second videos, trajectory length must not exceed 77 coordinates. */
- dynamic_masks?: KlingImage2VideoRequestDynamicMasksItem[];
- /** Customized Task ID. Must be unique within a single user account. */
- external_task_id?: string;
- /** Reference Image - URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1. Base64 should not include data:image prefix. */
- image?: string;
- /** Reference Image - End frame control. URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px. Base64 should not include data:image prefix. */
- image_tail?: string;
- mode?: KlingVideoGenMode;
- model_name?: KlingVideoGenModelName;
- /**
- * Negative text prompt
- * @maxLength 2500
- */
- negative_prompt?: string;
- /**
- * Positive text prompt
- * @maxLength 2500
- */
- prompt?: string;
- /** Static Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image. */
- static_mask?: string;
+ aspect_ratio?: KlingVideoGenAspectRatio;
+ /** The callback notification address. Server will notify when the task status changes. */
+ callback_url?: string;
+ camera_control?: KlingCameraControl;
+ cfg_scale?: KlingVideoGenCfgScale;
+ duration?: KlingVideoGenDuration;
+ /** Dynamic Brush Configuration List (up to 6 groups). For 5-second videos, trajectory length must not exceed 77 coordinates. */
+ dynamic_masks?: KlingImage2VideoRequestDynamicMasksItem[];
+ /** Customized Task ID. Must be unique within a single user account. */
+ external_task_id?: string;
+ /** Reference Image - URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1. Base64 should not include data:image prefix. */
+ image?: string;
+ /** Reference Image - End frame control. URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px. Base64 should not include data:image prefix. */
+ image_tail?: string;
+ mode?: KlingVideoGenMode;
+ model_name?: KlingVideoGenModelName;
+ /**
+ * Negative text prompt
+ * @maxLength 2500
+ */
+ negative_prompt?: string;
+ /**
+ * Positive text prompt
+ * @maxLength 2500
+ */
+ prompt?: string;
+ /** Static Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image. */
+ static_mask?: string;
}
export type KlingImage2VideoResponseDataTaskInfo = {
- external_task_id?: string;
+ external_task_id?: string;
};
export type KlingImage2VideoResponseDataTaskResult = {
- videos?: KlingVideoResult[];
+ videos?: KlingVideoResult[];
};
export type KlingImage2VideoResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_info?: KlingImage2VideoResponseDataTaskInfo;
- task_result?: KlingImage2VideoResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_info?: KlingImage2VideoResponseDataTaskInfo;
+ task_result?: KlingImage2VideoResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingImage2VideoResponse {
- /** Error code */
- code?: number;
- data?: KlingImage2VideoResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingImage2VideoResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
/**
* Aspect ratio of the generated images
*/
-export type KlingImageGenAspectRatio =
- (typeof KlingImageGenAspectRatio)[keyof typeof KlingImageGenAspectRatio];
+export type KlingImageGenAspectRatio = typeof KlingImageGenAspectRatio[keyof typeof KlingImageGenAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingImageGenAspectRatio = {
- "16:9": "16:9",
- "9:16": "9:16",
- "1:1": "1:1",
- "4:3": "4:3",
- "3:4": "3:4",
- "3:2": "3:2",
- "2:3": "2:3",
- "21:9": "21:9",
+ '16:9': '16:9',
+ '9:16': '9:16',
+ '1:1': '1:1',
+ '4:3': '4:3',
+ '3:4': '3:4',
+ '3:2': '3:2',
+ '2:3': '2:3',
+ '21:9': '21:9',
} as const;
/**
* Image reference type
*/
-export type KlingImageGenImageReferenceType =
- (typeof KlingImageGenImageReferenceType)[keyof typeof KlingImageGenImageReferenceType];
+export type KlingImageGenImageReferenceType = typeof KlingImageGenImageReferenceType[keyof typeof KlingImageGenImageReferenceType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingImageGenImageReferenceType = {
- subject: "subject",
- face: "face",
+ subject: 'subject',
+ face: 'face',
} as const;
/**
* Model Name
*/
-export type KlingImageGenModelName =
- (typeof KlingImageGenModelName)[keyof typeof KlingImageGenModelName];
+export type KlingImageGenModelName = typeof KlingImageGenModelName[keyof typeof KlingImageGenModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingImageGenModelName = {
- "kling-v1": "kling-v1",
- "kling-v1-5": "kling-v1-5",
- "kling-v2": "kling-v2",
+ 'kling-v1': 'kling-v1',
+ 'kling-v1-5': 'kling-v1-5',
+ 'kling-v2': 'kling-v2',
} as const;
export interface KlingImageGenerationsRequest {
- aspect_ratio?: KlingImageGenAspectRatio;
- /** The callback notification address */
- callback_url?: string;
- /**
- * Subject reference similarity
- * @minimum 0
- * @maximum 1
- */
- human_fidelity?: number;
- /** Reference Image - Base64 encoded string or image URL */
- image?: string;
- /**
- * Reference intensity for user-uploaded images
- * @minimum 0
- * @maximum 1
- */
- image_fidelity?: number;
- image_reference?: KlingImageGenImageReferenceType;
- model_name?: KlingImageGenModelName;
- /**
- * Number of generated images
- * @minimum 1
- * @maximum 9
- */
- n?: number;
- /**
- * Negative text prompt
- * @maxLength 200
- */
- negative_prompt?: string;
- /**
- * Positive text prompt
- * @maxLength 500
- */
- prompt: string;
+ aspect_ratio?: KlingImageGenAspectRatio;
+ /** The callback notification address */
+ callback_url?: string;
+ /**
+ * Subject reference similarity
+ * @minimum 0
+ * @maximum 1
+ */
+ human_fidelity?: number;
+ /** Reference Image - Base64 encoded string or image URL */
+ image?: string;
+ /**
+ * Reference intensity for user-uploaded images
+ * @minimum 0
+ * @maximum 1
+ */
+ image_fidelity?: number;
+ image_reference?: KlingImageGenImageReferenceType;
+ model_name?: KlingImageGenModelName;
+ /**
+ * Number of generated images
+ * @minimum 1
+ * @maximum 9
+ */
+ n?: number;
+ /**
+ * Negative text prompt
+ * @maxLength 200
+ */
+ negative_prompt?: string;
+ /**
+ * Positive text prompt
+ * @maxLength 500
+ */
+ prompt: string;
}
export type KlingImageGenerationsResponseDataTaskResult = {
- images?: KlingImageResult[];
+ images?: KlingImageResult[];
};
export type KlingImageGenerationsResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_result?: KlingImageGenerationsResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task status information */
- task_status_msg?: string;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_result?: KlingImageGenerationsResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task status information */
+ task_status_msg?: string;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingImageGenerationsResponse {
- /** Error code */
- code?: number;
- data?: KlingImageGenerationsResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingImageGenerationsResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
export interface KlingImageResult {
- /** Image Number (0-9) */
- index?: number;
- /** URL for generated image */
- url?: string;
+ /** Image Number (0-9) */
+ index?: number;
+ /** URL for generated image */
+ url?: string;
}
export interface KlingLipSyncInputObject {
- /** Local Path of Audio File. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. Base64 code. */
- audio_file?: string;
- audio_type?: KlingAudioUploadType;
- /** Audio File Download URL. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. */
- audio_url?: string;
- mode: KlingLipSyncMode;
- /** Text Content for Lip-Sync Video Generation. Required when mode is text2video. Maximum length is 120 characters. */
- text?: string;
- /** The ID of the video generated by Kling AI. Only supports 5-second and 10-second videos generated within the last 30 days. */
- video_id?: string;
- /** Get link for uploaded video. Video files support .mp4/.mov, file size does not exceed 100MB, video length between 2-10s. */
- video_url?: string;
- /** Voice ID. Required when mode is text2video. The system offers a variety of voice options to choose from. */
- voice_id?: string;
- voice_language?: KlingLipSyncVoiceLanguage;
- /**
- * Speech Rate. Valid range: 0.8~2.0, accurate to one decimal place.
- * @minimum 0.8
- * @maximum 2
- */
- voice_speed?: number;
+ /** Local Path of Audio File. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. Base64 code. */
+ audio_file?: string;
+ audio_type?: KlingAudioUploadType;
+ /** Audio File Download URL. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. */
+ audio_url?: string;
+ mode: KlingLipSyncMode;
+ /** Text Content for Lip-Sync Video Generation. Required when mode is text2video. Maximum length is 120 characters. */
+ text?: string;
+ /** The ID of the video generated by Kling AI. Only supports 5-second and 10-second videos generated within the last 30 days. */
+ video_id?: string;
+ /** Get link for uploaded video. Video files support .mp4/.mov, file size does not exceed 100MB, video length between 2-10s. */
+ video_url?: string;
+ /** Voice ID. Required when mode is text2video. The system offers a variety of voice options to choose from. */
+ voice_id?: string;
+ voice_language?: KlingLipSyncVoiceLanguage;
+ /**
+ * Speech Rate. Valid range: 0.8~2.0, accurate to one decimal place.
+ * @minimum 0.8
+ * @maximum 2
+ */
+ voice_speed?: number;
}
/**
* Video Generation Mode. text2video: Text-to-video generation mode; audio2video: Audio-to-video generation mode
*/
-export type KlingLipSyncMode =
- (typeof KlingLipSyncMode)[keyof typeof KlingLipSyncMode];
+export type KlingLipSyncMode = typeof KlingLipSyncMode[keyof typeof KlingLipSyncMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingLipSyncMode = {
- text2video: "text2video",
- audio2video: "audio2video",
+ text2video: 'text2video',
+ audio2video: 'audio2video',
} as const;
export interface KlingLipSyncRequest {
- /** The callback notification address. Server will notify when the task status changes. */
- callback_url?: string;
- input: KlingLipSyncInputObject;
+ /** The callback notification address. Server will notify when the task status changes. */
+ callback_url?: string;
+ input: KlingLipSyncInputObject;
}
export type KlingLipSyncResponseDataTaskInfo = {
- external_task_id?: string;
+ external_task_id?: string;
};
export type KlingLipSyncResponseDataTaskResult = {
- videos?: KlingVideoResult[];
+ videos?: KlingVideoResult[];
};
export type KlingLipSyncResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_info?: KlingLipSyncResponseDataTaskInfo;
- task_result?: KlingLipSyncResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_info?: KlingLipSyncResponseDataTaskInfo;
+ task_result?: KlingLipSyncResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingLipSyncResponse {
- /** Error code */
- code?: number;
- data?: KlingLipSyncResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingLipSyncResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
/**
* The voice language corresponds to the Voice ID.
*/
-export type KlingLipSyncVoiceLanguage =
- (typeof KlingLipSyncVoiceLanguage)[keyof typeof KlingLipSyncVoiceLanguage];
+export type KlingLipSyncVoiceLanguage = typeof KlingLipSyncVoiceLanguage[keyof typeof KlingLipSyncVoiceLanguage];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingLipSyncVoiceLanguage = {
- zh: "zh",
- en: "en",
+ zh: 'zh',
+ en: 'en',
} as const;
/**
* Resource package type (decreasing_total=decreasing total, constant_period=constant periodicity)
*/
-export type KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType =
- (typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType)[keyof typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType];
+export type KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType = typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType[keyof typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType =
- {
- decreasing_total: "decreasing_total",
- constant_period: "constant_period",
- } as const;
+export const KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType = {
+ decreasing_total: 'decreasing_total',
+ constant_period: 'constant_period',
+} as const;
/**
* Resource Package Status
*/
-export type KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus =
- (typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus)[keyof typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus];
+export type KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus = typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus[keyof typeof KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus =
- {
- toBeOnline: "toBeOnline",
- online: "online",
- expired: "expired",
- runOut: "runOut",
- } as const;
+export const KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus = {
+ toBeOnline: 'toBeOnline',
+ online: 'online',
+ expired: 'expired',
+ runOut: 'runOut',
+} as const;
export type KlingResourcePackageResponseDataResourcePackSubscribeInfosItem = {
- /** Effective time, Unix timestamp in ms */
- effective_time?: number;
- /** Expiration time, Unix timestamp in ms */
- invalid_time?: number;
- /** Purchase time, Unix timestamp in ms */
- purchase_time?: number;
- /** Remaining quantity (updated with a 12-hour delay) */
- remaining_quantity?: number;
- /** Resource package ID */
- resource_pack_id?: string;
- /** Resource package name */
- resource_pack_name?: string;
- /** Resource package type (decreasing_total=decreasing total, constant_period=constant periodicity) */
- resource_pack_type?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType;
- /** Resource Package Status */
- status?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus;
- /** Total quantity */
- total_quantity?: number;
+ /** Effective time, Unix timestamp in ms */
+ effective_time?: number;
+ /** Expiration time, Unix timestamp in ms */
+ invalid_time?: number;
+ /** Purchase time, Unix timestamp in ms */
+ purchase_time?: number;
+ /** Remaining quantity (updated with a 12-hour delay) */
+ remaining_quantity?: number;
+ /** Resource package ID */
+ resource_pack_id?: string;
+ /** Resource package name */
+ resource_pack_name?: string;
+ /** Resource package type (decreasing_total=decreasing total, constant_period=constant periodicity) */
+ resource_pack_type?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItemResourcePackType;
+ /** Resource Package Status */
+ status?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItemStatus;
+ /** Total quantity */
+ total_quantity?: number;
};
export type KlingResourcePackageResponseData = {
- /** Error code; 0 indicates success */
- code?: number;
- /** Error information */
- msg?: string;
- /** Resource package list */
- resource_pack_subscribe_infos?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItem[];
+ /** Error code; 0 indicates success */
+ code?: number;
+ /** Error information */
+ msg?: string;
+ /** Resource package list */
+ resource_pack_subscribe_infos?: KlingResourcePackageResponseDataResourcePackSubscribeInfosItem[];
};
export interface KlingResourcePackageResponse {
- /** Error code; 0 indicates success */
- code?: number;
- data?: KlingResourcePackageResponseData;
- /** Error information */
- message?: string;
- /** Request ID, generated by the system, used to track requests and troubleshoot problems */
- request_id?: string;
+ /** Error code; 0 indicates success */
+ code?: number;
+ data?: KlingResourcePackageResponseData;
+ /** Error information */
+ message?: string;
+ /** Request ID, generated by the system, used to track requests and troubleshoot problems */
+ request_id?: string;
}
/**
* Video Length in seconds. Only 5-second videos are supported.
*/
-export type KlingSingleImageEffectDuration =
- (typeof KlingSingleImageEffectDuration)[keyof typeof KlingSingleImageEffectDuration];
+export type KlingSingleImageEffectDuration = typeof KlingSingleImageEffectDuration[keyof typeof KlingSingleImageEffectDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingSingleImageEffectDuration = {
- NUMBER_5: "5",
+ NUMBER_5: '5',
} as const;
export interface KlingSingleImageEffectInput {
- duration: KlingSingleImageEffectDuration;
- /** Reference Image. URL or Base64 encoded string (without data:image prefix). File size cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1. */
- image: string;
- model_name: KlingSingleImageEffectModelName;
+ duration: KlingSingleImageEffectDuration;
+ /** Reference Image. URL or Base64 encoded string (without data:image prefix). File size cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1. */
+ image: string;
+ model_name: KlingSingleImageEffectModelName;
}
/**
* Model Name. Only kling-v1-6 is supported for single image effects.
*/
-export type KlingSingleImageEffectModelName =
- (typeof KlingSingleImageEffectModelName)[keyof typeof KlingSingleImageEffectModelName];
+export type KlingSingleImageEffectModelName = typeof KlingSingleImageEffectModelName[keyof typeof KlingSingleImageEffectModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingSingleImageEffectModelName = {
- "kling-v1-6": "kling-v1-6",
+ 'kling-v1-6': 'kling-v1-6',
} as const;
/**
* Scene Name. Single Image Effects (bloombloom, dizzydizzy, fuzzyfuzzy, squish, expansion).
*/
-export type KlingSingleImageEffectsScene =
- (typeof KlingSingleImageEffectsScene)[keyof typeof KlingSingleImageEffectsScene];
+export type KlingSingleImageEffectsScene = typeof KlingSingleImageEffectsScene[keyof typeof KlingSingleImageEffectsScene];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingSingleImageEffectsScene = {
- bloombloom: "bloombloom",
- dizzydizzy: "dizzydizzy",
- fuzzyfuzzy: "fuzzyfuzzy",
- squish: "squish",
- expansion: "expansion",
+ bloombloom: 'bloombloom',
+ dizzydizzy: 'dizzydizzy',
+ fuzzyfuzzy: 'fuzzyfuzzy',
+ squish: 'squish',
+ expansion: 'expansion',
} as const;
/**
* Task Status
*/
-export type KlingTaskStatus =
- (typeof KlingTaskStatus)[keyof typeof KlingTaskStatus];
+export type KlingTaskStatus = typeof KlingTaskStatus[keyof typeof KlingTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingTaskStatus = {
- submitted: "submitted",
- processing: "processing",
- succeed: "succeed",
- failed: "failed",
+ submitted: 'submitted',
+ processing: 'processing',
+ succeed: 'succeed',
+ failed: 'failed',
} as const;
export interface KlingText2VideoRequest {
- aspect_ratio?: KlingVideoGenAspectRatio;
- /** The callback notification address */
- callback_url?: string;
- camera_control?: KlingCameraControl;
- cfg_scale?: KlingVideoGenCfgScale;
- duration?: KlingVideoGenDuration;
- /** Customized Task ID */
- external_task_id?: string;
- mode?: KlingVideoGenMode;
- model_name?: KlingTextToVideoModelName;
- /**
- * Negative text prompt
- * @maxLength 2500
- */
- negative_prompt?: string;
- /**
- * Positive text prompt
- * @maxLength 2500
- */
- prompt?: string;
+ aspect_ratio?: KlingVideoGenAspectRatio;
+ /** The callback notification address */
+ callback_url?: string;
+ camera_control?: KlingCameraControl;
+ cfg_scale?: KlingVideoGenCfgScale;
+ duration?: KlingVideoGenDuration;
+ /** Customized Task ID */
+ external_task_id?: string;
+ mode?: KlingVideoGenMode;
+ model_name?: KlingTextToVideoModelName;
+ /**
+ * Negative text prompt
+ * @maxLength 2500
+ */
+ negative_prompt?: string;
+ /**
+ * Positive text prompt
+ * @maxLength 2500
+ */
+ prompt?: string;
}
export type KlingText2VideoResponseDataTaskInfo = {
- external_task_id?: string;
+ external_task_id?: string;
};
export type KlingText2VideoResponseDataTaskResult = {
- videos?: KlingVideoResult[];
+ videos?: KlingVideoResult[];
};
export type KlingText2VideoResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_info?: KlingText2VideoResponseDataTaskInfo;
- task_result?: KlingText2VideoResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_info?: KlingText2VideoResponseDataTaskInfo;
+ task_result?: KlingText2VideoResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingText2VideoResponse {
- /** Error code */
- code?: number;
- data?: KlingText2VideoResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingText2VideoResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
/**
* Model Name
*/
-export type KlingTextToVideoModelName =
- (typeof KlingTextToVideoModelName)[keyof typeof KlingTextToVideoModelName];
+export type KlingTextToVideoModelName = typeof KlingTextToVideoModelName[keyof typeof KlingTextToVideoModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingTextToVideoModelName = {
- "kling-v1": "kling-v1",
- "kling-v1-5": "kling-v1-5",
- "kling-v1-6": "kling-v1-6",
- "kling-v2-master": "kling-v2-master",
- "kling-v2-1-master": "kling-v2-1-master",
+ 'kling-v1': 'kling-v1',
+ 'kling-v1-5': 'kling-v1-5',
+ 'kling-v1-6': 'kling-v1-6',
+ 'kling-v2-master': 'kling-v2-master',
+ 'kling-v2-1-master': 'kling-v2-1-master',
+ 'kling-v2-5-turbo': 'kling-v2-5-turbo',
} as const;
-export type KlingVideoEffectsInput =
- | KlingSingleImageEffectInput
- | KlingDualCharacterEffectInput;
+export type KlingVideoEffectsInput = KlingSingleImageEffectInput | KlingDualCharacterEffectInput;
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const KlingVideoEffectsRequestEffectScene = {
- ...KlingDualCharacterEffectsScene,
- ...KlingSingleImageEffectsScene,
-} as const;
+export const KlingVideoEffectsRequestEffectScene = {...KlingDualCharacterEffectsScene,...KlingSingleImageEffectsScene,} as const
export interface KlingVideoEffectsRequest {
- /** The callback notification address for the result of this task. */
- callback_url?: string;
- effect_scene: (typeof KlingVideoEffectsRequestEffectScene)[keyof typeof KlingVideoEffectsRequestEffectScene];
- /** Customized Task ID. Must be unique within a single user account. */
- external_task_id?: string;
- input: KlingVideoEffectsInput;
+ /** The callback notification address for the result of this task. */
+ callback_url?: string;
+ effect_scene: typeof KlingVideoEffectsRequestEffectScene[keyof typeof KlingVideoEffectsRequestEffectScene] ;
+ /** Customized Task ID. Must be unique within a single user account. */
+ external_task_id?: string;
+ input: KlingVideoEffectsInput;
}
export type KlingVideoEffectsResponseDataTaskInfo = {
- external_task_id?: string;
+ external_task_id?: string;
};
export type KlingVideoEffectsResponseDataTaskResult = {
- videos?: KlingVideoResult[];
+ videos?: KlingVideoResult[];
};
export type KlingVideoEffectsResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_info?: KlingVideoEffectsResponseDataTaskInfo;
- task_result?: KlingVideoEffectsResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_info?: KlingVideoEffectsResponseDataTaskInfo;
+ task_result?: KlingVideoEffectsResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingVideoEffectsResponse {
- /** Error code */
- code?: number;
- data?: KlingVideoEffectsResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingVideoEffectsResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
export interface KlingVideoExtendRequest {
- /** The callback notification address. Server will notify when the task status changes. */
- callback_url?: string;
- cfg_scale?: KlingVideoGenCfgScale;
- /**
- * Negative text prompt for elements to avoid in the extended video
- * @maxLength 2500
- */
- negative_prompt?: string;
- /**
- * Positive text prompt for guiding the video extension
- * @maxLength 2500
- */
- prompt?: string;
- /** The ID of the video to be extended. Supports videos generated by text-to-video, image-to-video, and previous video extension operations. Cannot exceed 3 minutes total duration after extension. */
- video_id?: string;
+ /** The callback notification address. Server will notify when the task status changes. */
+ callback_url?: string;
+ cfg_scale?: KlingVideoGenCfgScale;
+ /**
+ * Negative text prompt for elements to avoid in the extended video
+ * @maxLength 2500
+ */
+ negative_prompt?: string;
+ /**
+ * Positive text prompt for guiding the video extension
+ * @maxLength 2500
+ */
+ prompt?: string;
+ /** The ID of the video to be extended. Supports videos generated by text-to-video, image-to-video, and previous video extension operations. Cannot exceed 3 minutes total duration after extension. */
+ video_id?: string;
}
export type KlingVideoExtendResponseDataTaskInfo = {
- external_task_id?: string;
+ external_task_id?: string;
};
export type KlingVideoExtendResponseDataTaskResult = {
- videos?: KlingVideoResult[];
+ videos?: KlingVideoResult[];
};
export type KlingVideoExtendResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_info?: KlingVideoExtendResponseDataTaskInfo;
- task_result?: KlingVideoExtendResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_info?: KlingVideoExtendResponseDataTaskInfo;
+ task_result?: KlingVideoExtendResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingVideoExtendResponse {
- /** Error code */
- code?: number;
- data?: KlingVideoExtendResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingVideoExtendResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
/**
* Video aspect ratio
*/
-export type KlingVideoGenAspectRatio =
- (typeof KlingVideoGenAspectRatio)[keyof typeof KlingVideoGenAspectRatio];
+export type KlingVideoGenAspectRatio = typeof KlingVideoGenAspectRatio[keyof typeof KlingVideoGenAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingVideoGenAspectRatio = {
- "16:9": "16:9",
- "9:16": "9:16",
- "1:1": "1:1",
+ '16:9': '16:9',
+ '9:16': '9:16',
+ '1:1': '1:1',
} as const;
/**
@@ -3055,313 +3080,310 @@ export type KlingVideoGenCfgScale = number;
/**
* Video length in seconds
*/
-export type KlingVideoGenDuration =
- (typeof KlingVideoGenDuration)[keyof typeof KlingVideoGenDuration];
+export type KlingVideoGenDuration = typeof KlingVideoGenDuration[keyof typeof KlingVideoGenDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingVideoGenDuration = {
- NUMBER_5: "5",
- NUMBER_10: "10",
+ NUMBER_5: '5',
+ NUMBER_10: '10',
} as const;
/**
* Video generation mode. std: Standard Mode, which is cost-effective. pro: Professional Mode, generates videos with longer duration but higher quality output.
*/
-export type KlingVideoGenMode =
- (typeof KlingVideoGenMode)[keyof typeof KlingVideoGenMode];
+export type KlingVideoGenMode = typeof KlingVideoGenMode[keyof typeof KlingVideoGenMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingVideoGenMode = {
- std: "std",
- pro: "pro",
+ std: 'std',
+ pro: 'pro',
} as const;
/**
* Model Name
*/
-export type KlingVideoGenModelName =
- (typeof KlingVideoGenModelName)[keyof typeof KlingVideoGenModelName];
+export type KlingVideoGenModelName = typeof KlingVideoGenModelName[keyof typeof KlingVideoGenModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingVideoGenModelName = {
- "kling-v1": "kling-v1",
- "kling-v1-5": "kling-v1-5",
- "kling-v1-6": "kling-v1-6",
- "kling-v2-master": "kling-v2-master",
- "kling-v2-1": "kling-v2-1",
- "kling-v2-1-master": "kling-v2-1-master",
+ 'kling-v1': 'kling-v1',
+ 'kling-v1-5': 'kling-v1-5',
+ 'kling-v1-6': 'kling-v1-6',
+ 'kling-v2-master': 'kling-v2-master',
+ 'kling-v2-1': 'kling-v2-1',
+ 'kling-v2-1-master': 'kling-v2-1-master',
+ 'kling-v2-5-turbo': 'kling-v2-5-turbo',
} as const;
export interface KlingVideoResult {
- /** Total video duration */
- duration?: string;
- /** Generated video ID */
- id?: string;
- /** URL for generated video */
- url?: string;
+ /** Total video duration */
+ duration?: string;
+ /** Generated video ID */
+ id?: string;
+ /** URL for generated video */
+ url?: string;
}
/**
* Model Name
*/
-export type KlingVirtualTryOnModelName =
- (typeof KlingVirtualTryOnModelName)[keyof typeof KlingVirtualTryOnModelName];
+export type KlingVirtualTryOnModelName = typeof KlingVirtualTryOnModelName[keyof typeof KlingVirtualTryOnModelName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const KlingVirtualTryOnModelName = {
- "kolors-virtual-try-on-v1": "kolors-virtual-try-on-v1",
- "kolors-virtual-try-on-v1-5": "kolors-virtual-try-on-v1-5",
+ 'kolors-virtual-try-on-v1': 'kolors-virtual-try-on-v1',
+ 'kolors-virtual-try-on-v1-5': 'kolors-virtual-try-on-v1-5',
} as const;
export interface KlingVirtualTryOnRequest {
- /** The callback notification address */
- callback_url?: string;
- /** Reference clothing image - Base64 encoded string or image URL */
- cloth_image?: string;
- /** Reference human image - Base64 encoded string or image URL */
- human_image: string;
- model_name?: KlingVirtualTryOnModelName;
+ /** The callback notification address */
+ callback_url?: string;
+ /** Reference clothing image - Base64 encoded string or image URL */
+ cloth_image?: string;
+ /** Reference human image - Base64 encoded string or image URL */
+ human_image: string;
+ model_name?: KlingVirtualTryOnModelName;
}
export type KlingVirtualTryOnResponseDataTaskResult = {
- images?: KlingImageResult[];
+ images?: KlingImageResult[];
};
export type KlingVirtualTryOnResponseData = {
- /** Task creation time */
- created_at?: number;
- /** Task ID */
- task_id?: string;
- task_result?: KlingVirtualTryOnResponseDataTaskResult;
- task_status?: KlingTaskStatus;
- /** Task status information */
- task_status_msg?: string;
- /** Task update time */
- updated_at?: number;
+ /** Task creation time */
+ created_at?: number;
+ /** Task ID */
+ task_id?: string;
+ task_result?: KlingVirtualTryOnResponseDataTaskResult;
+ task_status?: KlingTaskStatus;
+ /** Task status information */
+ task_status_msg?: string;
+ /** Task update time */
+ updated_at?: number;
};
export interface KlingVirtualTryOnResponse {
- /** Error code */
- code?: number;
- data?: KlingVirtualTryOnResponseData;
- /** Error message */
- message?: string;
- /** Request ID */
- request_id?: string;
+ /** Error code */
+ code?: number;
+ data?: KlingVirtualTryOnResponseData;
+ /** Error message */
+ message?: string;
+ /** Request ID */
+ request_id?: string;
}
/**
* The aspect ratio of the generation
*/
-export type LumaAspectRatio =
- (typeof LumaAspectRatio)[keyof typeof LumaAspectRatio];
+export type LumaAspectRatio = typeof LumaAspectRatio[keyof typeof LumaAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaAspectRatio = {
- "1:1": "1:1",
- "16:9": "16:9",
- "9:16": "9:16",
- "4:3": "4:3",
- "3:4": "3:4",
- "21:9": "21:9",
- "9:21": "9:21",
+ '1:1': '1:1',
+ '16:9': '16:9',
+ '9:16': '9:16',
+ '4:3': '4:3',
+ '3:4': '3:4',
+ '21:9': '21:9',
+ '9:21': '9:21',
} as const;
/**
* The assets of the generation
*/
export interface LumaAssets {
- /** The URL of the image */
- image?: string;
- /** The URL of the progress video */
- progress_video?: string;
- /** The URL of the video */
- video?: string;
+ /** The URL of the image */
+ image?: string;
+ /** The URL of the progress video */
+ progress_video?: string;
+ /** The URL of the video */
+ video?: string;
}
-export type LumaAudioGenerationRequestGenerationType =
- (typeof LumaAudioGenerationRequestGenerationType)[keyof typeof LumaAudioGenerationRequestGenerationType];
+export type LumaAudioGenerationRequestGenerationType = typeof LumaAudioGenerationRequestGenerationType[keyof typeof LumaAudioGenerationRequestGenerationType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaAudioGenerationRequestGenerationType = {
- add_audio: "add_audio",
+ add_audio: 'add_audio',
} as const;
/**
* The audio generation request object
*/
export interface LumaAudioGenerationRequest {
- /** The callback URL for the audio */
- callback_url?: string;
- generation_type?: LumaAudioGenerationRequestGenerationType;
- /** The negative prompt of the audio */
- negative_prompt?: string;
- /** The prompt of the audio */
- prompt?: string;
+ /** The callback URL for the audio */
+ callback_url?: string;
+ generation_type?: LumaAudioGenerationRequestGenerationType;
+ /** The negative prompt of the audio */
+ negative_prompt?: string;
+ /** The prompt of the audio */
+ prompt?: string;
}
/**
* The error object
*/
export interface LumaError {
- /** The error message */
- detail?: string;
+ /** The error message */
+ detail?: string;
}
/**
* The request of the generation
*/
-export type LumaGenerationRequestProperty =
- | LumaGenerationRequest
- | LumaImageGenerationRequest
- | LumaUpscaleVideoGenerationRequest
- | LumaAudioGenerationRequest;
+export type LumaGenerationRequestProperty = LumaGenerationRequest | LumaImageGenerationRequest | LumaUpscaleVideoGenerationRequest | LumaAudioGenerationRequest;
/**
* The generation response object
*/
export interface LumaGeneration {
- assets?: LumaAssets;
- /** The date and time when the generation was created */
- created_at?: string;
- /** The reason for the state of the generation */
- failure_reason?: string;
- generation_type?: LumaGenerationType;
- /** The ID of the generation */
- id?: string;
- /** The model used for the generation */
- model?: string;
- /** The request of the generation */
- request?: LumaGenerationRequestProperty;
- state?: LumaState;
+ assets?: LumaAssets;
+ /** The date and time when the generation was created */
+ created_at?: string;
+ /** The reason for the state of the generation */
+ failure_reason?: string;
+ generation_type?: LumaGenerationType;
+ /** The ID of the generation */
+ id?: string;
+ /** The model used for the generation */
+ model?: string;
+ /** The request of the generation */
+ request?: LumaGenerationRequestProperty;
+ state?: LumaState;
}
-export type LumaGenerationReferenceType =
- (typeof LumaGenerationReferenceType)[keyof typeof LumaGenerationReferenceType];
+export type LumaGenerationReferenceType = typeof LumaGenerationReferenceType[keyof typeof LumaGenerationReferenceType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaGenerationReferenceType = {
- generation: "generation",
+ generation: 'generation',
} as const;
/**
* The generation reference object
*/
export interface LumaGenerationReference {
- /** The ID of the generation */
- id: string;
- type: LumaGenerationReferenceType;
+ /** The ID of the generation */
+ id: string;
+ type: LumaGenerationReferenceType;
}
-export type LumaGenerationRequestGenerationType =
- (typeof LumaGenerationRequestGenerationType)[keyof typeof LumaGenerationRequestGenerationType];
+export type LumaGenerationRequestGenerationType = typeof LumaGenerationRequestGenerationType[keyof typeof LumaGenerationRequestGenerationType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaGenerationRequestGenerationType = {
- video: "video",
+ video: 'video',
} as const;
/**
* The generation request object
*/
export interface LumaGenerationRequest {
- aspect_ratio: LumaAspectRatio;
- /** The callback URL of the generation, a POST request with Generation object will be sent to the callback URL when the generation is dreaming, completed, or failed */
- callback_url?: string;
- duration: LumaVideoModelOutputDuration;
- generation_type?: LumaGenerationRequestGenerationType;
- keyframes?: LumaKeyframes;
- /** Whether to loop the video */
- loop?: boolean;
- model: LumaVideoModel;
- /** The prompt of the generation */
- prompt: string;
- resolution: LumaVideoModelOutputResolution;
+ aspect_ratio: LumaAspectRatio;
+ /** The callback URL of the generation, a POST request with Generation object will be sent to the callback URL when the generation is dreaming, completed, or failed */
+ callback_url?: string;
+ duration: LumaVideoModelOutputDuration;
+ generation_type?: LumaGenerationRequestGenerationType;
+ keyframes?: LumaKeyframes;
+ /** Whether to loop the video */
+ loop?: boolean;
+ model: LumaVideoModel;
+ /** The prompt of the generation */
+ prompt: string;
+ resolution: LumaVideoModelOutputResolution;
}
-export type LumaGenerationType =
- (typeof LumaGenerationType)[keyof typeof LumaGenerationType];
+export type LumaGenerationType = typeof LumaGenerationType[keyof typeof LumaGenerationType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaGenerationType = {
- video: "video",
- image: "image",
+ video: 'video',
+ image: 'image',
} as const;
export type LumaImageGenerationRequestCharacterRef = {
- identity0?: LumaImageIdentity;
+ identity0?: LumaImageIdentity;
};
-export type LumaImageGenerationRequestGenerationType =
- (typeof LumaImageGenerationRequestGenerationType)[keyof typeof LumaImageGenerationRequestGenerationType];
+export type LumaImageGenerationRequestGenerationType = typeof LumaImageGenerationRequestGenerationType[keyof typeof LumaImageGenerationRequestGenerationType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaImageGenerationRequestGenerationType = {
- image: "image",
+ image: 'image',
} as const;
/**
* The image generation request object
*/
export interface LumaImageGenerationRequest {
- aspect_ratio?: LumaAspectRatio;
- /** The callback URL for the generation */
- callback_url?: string;
- character_ref?: LumaImageGenerationRequestCharacterRef;
- generation_type?: LumaImageGenerationRequestGenerationType;
- image_ref?: LumaImageRef[];
- model?: LumaImageModel;
- modify_image_ref?: LumaModifyImageRef;
- /** The prompt of the generation */
- prompt?: string;
- style_ref?: LumaImageRef[];
+ aspect_ratio?: LumaAspectRatio;
+ /** The callback URL for the generation */
+ callback_url?: string;
+ character_ref?: LumaImageGenerationRequestCharacterRef;
+ generation_type?: LumaImageGenerationRequestGenerationType;
+ image_ref?: LumaImageRef[];
+ model?: LumaImageModel;
+ modify_image_ref?: LumaModifyImageRef;
+ /** The prompt of the generation */
+ prompt?: string;
+ style_ref?: LumaImageRef[];
}
/**
* The image identity object
*/
export interface LumaImageIdentity {
- /** The URLs of the image identity */
- images?: string[];
+ /** The URLs of the image identity */
+ images?: string[];
}
/**
* The image model used for the generation
*/
-export type LumaImageModel =
- (typeof LumaImageModel)[keyof typeof LumaImageModel];
+export type LumaImageModel = typeof LumaImageModel[keyof typeof LumaImageModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaImageModel = {
- "photon-1": "photon-1",
- "photon-flash-1": "photon-flash-1",
+ 'photon-1': 'photon-1',
+ 'photon-flash-1': 'photon-flash-1',
} as const;
/**
* The image reference object
*/
export interface LumaImageRef {
- /** The URL of the image reference */
- url?: string;
- /** The weight of the image reference */
- weight?: number;
+ /** The URL of the image reference */
+ url?: string;
+ /** The weight of the image reference */
+ weight?: number;
}
-export type LumaImageReferenceType =
- (typeof LumaImageReferenceType)[keyof typeof LumaImageReferenceType];
+export type LumaImageReferenceType = typeof LumaImageReferenceType[keyof typeof LumaImageReferenceType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaImageReferenceType = {
- image: "image",
+ image: 'image',
} as const;
/**
* The image object
*/
export interface LumaImageReference {
- type: LumaImageReferenceType;
- /** The URL of the image */
- url: string;
+ type: LumaImageReferenceType;
+ /** The URL of the image */
+ url: string;
}
/**
@@ -3373,72 +3395,68 @@ export type LumaKeyframe = LumaGenerationReference | LumaImageReference;
* The keyframes of the generation
*/
export interface LumaKeyframes {
- frame0?: LumaKeyframe;
- frame1?: LumaKeyframe;
+ frame0?: LumaKeyframe;
+ frame1?: LumaKeyframe;
}
/**
* The modify image reference object
*/
export interface LumaModifyImageRef {
- /** The URL of the image reference */
- url?: string;
- /** The weight of the modify image reference */
- weight?: number;
+ /** The URL of the image reference */
+ url?: string;
+ /** The weight of the modify image reference */
+ weight?: number;
}
/**
* The state of the generation
*/
-export type LumaState = (typeof LumaState)[keyof typeof LumaState];
+export type LumaState = typeof LumaState[keyof typeof LumaState];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaState = {
- queued: "queued",
- dreaming: "dreaming",
- completed: "completed",
- failed: "failed",
+ queued: 'queued',
+ dreaming: 'dreaming',
+ completed: 'completed',
+ failed: 'failed',
} as const;
-export type LumaUpscaleVideoGenerationRequestGenerationType =
- (typeof LumaUpscaleVideoGenerationRequestGenerationType)[keyof typeof LumaUpscaleVideoGenerationRequestGenerationType];
+export type LumaUpscaleVideoGenerationRequestGenerationType = typeof LumaUpscaleVideoGenerationRequestGenerationType[keyof typeof LumaUpscaleVideoGenerationRequestGenerationType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaUpscaleVideoGenerationRequestGenerationType = {
- upscale_video: "upscale_video",
+ upscale_video: 'upscale_video',
} as const;
/**
* The upscale generation request object
*/
export interface LumaUpscaleVideoGenerationRequest {
- /** The callback URL for the upscale */
- callback_url?: string;
- generation_type?: LumaUpscaleVideoGenerationRequestGenerationType;
- resolution?: LumaVideoModelOutputResolution;
+ /** The callback URL for the upscale */
+ callback_url?: string;
+ generation_type?: LumaUpscaleVideoGenerationRequestGenerationType;
+ resolution?: LumaVideoModelOutputResolution;
}
/**
* The video model used for the generation
*/
-export type LumaVideoModel =
- (typeof LumaVideoModel)[keyof typeof LumaVideoModel];
+export type LumaVideoModel = typeof LumaVideoModel[keyof typeof LumaVideoModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LumaVideoModel = {
- "ray-2": "ray-2",
- "ray-flash-2": "ray-flash-2",
- "ray-1-6": "ray-1-6",
+ 'ray-2': 'ray-2',
+ 'ray-flash-2': 'ray-flash-2',
+ 'ray-1-6': 'ray-1-6',
} as const;
-export type LumaVideoModelOutputDuration = "5s" | "9s" | string;
+export type LumaVideoModelOutputDuration = '5s' | '9s' | string;
-export type LumaVideoModelOutputResolution =
- | "540p"
- | "720p"
- | "1080p"
- | "4k"
- | string;
+export type LumaVideoModelOutputResolution = '540p' | '720p' | '1080p' | '4k' | string;
/**
* Time series of VRAM usage.
@@ -3446,492 +3464,493 @@ export type LumaVideoModelOutputResolution =
export type MachineStatsVramTimeSeries = { [key: string]: unknown };
export interface MachineStats {
- /** Total CPU on the machine. */
- cpu_capacity?: string;
- /** Total disk capacity on the machine. */
- disk_capacity?: string;
- /** The GPU type. eg. NVIDIA Tesla K80 */
- gpu_type?: string;
- /** Initial CPU available before the job starts. */
- initial_cpu?: string;
- /** Initial disk available before the job starts. */
- initial_disk?: string;
- /** Initial RAM available before the job starts. */
- initial_ram?: string;
- /** Name of the machine. */
- machine_name?: string;
- /** Total memory on the machine. */
- memory_capacity?: string;
- /** The operating system version. eg. Ubuntu Linux 20.04 */
- os_version?: string;
- /** The pip freeze output */
- pip_freeze?: string;
- /** Time series of VRAM usage. */
- vram_time_series?: MachineStatsVramTimeSeries;
+ /** Total CPU on the machine. */
+ cpu_capacity?: string;
+ /** Total disk capacity on the machine. */
+ disk_capacity?: string;
+ /** The GPU type. eg. NVIDIA Tesla K80 */
+ gpu_type?: string;
+ /** Initial CPU available before the job starts. */
+ initial_cpu?: string;
+ /** Initial disk available before the job starts. */
+ initial_disk?: string;
+ /** Initial RAM available before the job starts. */
+ initial_ram?: string;
+ /** Name of the machine. */
+ machine_name?: string;
+ /** Total memory on the machine. */
+ memory_capacity?: string;
+ /** The operating system version. eg. Ubuntu Linux 20.04 */
+ os_version?: string;
+ /** The pip freeze output */
+ pip_freeze?: string;
+ /** Time series of VRAM usage. */
+ vram_time_series?: MachineStatsVramTimeSeries;
}
/**
* Common response structure used by Minimax APIs
*/
export interface MinimaxBaseResponse {
- /** Status code. 0 indicates success, other values indicate errors. */
- status_code: number;
- /** Specific error details or success message. */
- status_msg: string;
+ /** Status code. 0 indicates success, other values indicate errors. */
+ status_code: number;
+ /** Specific error details or success message. */
+ status_msg: string;
}
export type MinimaxFileRetrieveResponseFile = {
- /** File size in bytes */
- bytes?: number;
- /** Unix timestamp when the file was created, in seconds */
- created_at?: number;
- /** The URL to download the video */
- download_url?: string;
- /** Unique identifier for the file */
- file_id?: number;
- /** The name of the file */
- filename?: string;
- /** The purpose of using the file */
- purpose?: string;
+ /** File size in bytes */
+ bytes?: number;
+ /** Unix timestamp when the file was created, in seconds */
+ created_at?: number;
+ /** The URL to download the video */
+ download_url?: string;
+ /** Unique identifier for the file */
+ file_id?: number;
+ /** The name of the file */
+ filename?: string;
+ /** The purpose of using the file */
+ purpose?: string;
};
/**
* Response from retrieving a Minimax file download URL.
*/
export interface MinimaxFileRetrieveResponse {
- base_resp: MinimaxBaseResponse;
- file: MinimaxFileRetrieveResponseFile;
+ base_resp: MinimaxBaseResponse;
+ file: MinimaxFileRetrieveResponseFile;
}
/**
* Task status: 'Queueing' (in queue), 'Preparing' (task is preparing), 'Processing' (generating), 'Success' (task completed successfully), or 'Fail' (task failed).
*/
-export type MinimaxTaskResultResponseStatus =
- (typeof MinimaxTaskResultResponseStatus)[keyof typeof MinimaxTaskResultResponseStatus];
+export type MinimaxTaskResultResponseStatus = typeof MinimaxTaskResultResponseStatus[keyof typeof MinimaxTaskResultResponseStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const MinimaxTaskResultResponseStatus = {
- Queueing: "Queueing",
- Preparing: "Preparing",
- Processing: "Processing",
- Success: "Success",
- Fail: "Fail",
+ Queueing: 'Queueing',
+ Preparing: 'Preparing',
+ Processing: 'Processing',
+ Success: 'Success',
+ Fail: 'Fail',
} as const;
/**
* Response from querying a Minimax video generation task status.
*/
export interface MinimaxTaskResultResponse {
- base_resp: MinimaxBaseResponse;
- /** After the task status changes to Success, this field returns the file ID corresponding to the generated video. */
- file_id?: string;
- /** Task status: 'Queueing' (in queue), 'Preparing' (task is preparing), 'Processing' (generating), 'Success' (task completed successfully), or 'Fail' (task failed). */
- status: MinimaxTaskResultResponseStatus;
- /** The task ID being queried. */
- task_id: string;
+ base_resp: MinimaxBaseResponse;
+ /** After the task status changes to Success, this field returns the file ID corresponding to the generated video. */
+ file_id?: string;
+ /** Task status: 'Queueing' (in queue), 'Preparing' (task is preparing), 'Processing' (generating), 'Success' (task completed successfully), or 'Fail' (task failed). */
+ status: MinimaxTaskResultResponseStatus;
+ /** The task ID being queried. */
+ task_id: string;
}
/**
* Video length in seconds. Only available for MiniMax-Hailuo-02
*/
-export type MinimaxVideoGenerationRequestDuration =
- (typeof MinimaxVideoGenerationRequestDuration)[keyof typeof MinimaxVideoGenerationRequestDuration];
+export type MinimaxVideoGenerationRequestDuration = typeof MinimaxVideoGenerationRequestDuration[keyof typeof MinimaxVideoGenerationRequestDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const MinimaxVideoGenerationRequestDuration = {
- NUMBER_6: 6,
- NUMBER_10: 10,
+ NUMBER_6: 6,
+ NUMBER_10: 10,
} as const;
/**
* Required. ID of model. Options: MiniMax-Hailuo-02, T2V-01-Director, I2V-01-Director, S2V-01, I2V-01, I2V-01-live, T2V-01
*/
-export type MinimaxVideoGenerationRequestModel =
- (typeof MinimaxVideoGenerationRequestModel)[keyof typeof MinimaxVideoGenerationRequestModel];
+export type MinimaxVideoGenerationRequestModel = typeof MinimaxVideoGenerationRequestModel[keyof typeof MinimaxVideoGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const MinimaxVideoGenerationRequestModel = {
- "MiniMax-Hailuo-02": "MiniMax-Hailuo-02",
- "T2V-01-Director": "T2V-01-Director",
- "I2V-01-Director": "I2V-01-Director",
- "S2V-01": "S2V-01",
- "I2V-01": "I2V-01",
- "I2V-01-live": "I2V-01-live",
- "T2V-01": "T2V-01",
+ 'MiniMax-Hailuo-02': 'MiniMax-Hailuo-02',
+ 'T2V-01-Director': 'T2V-01-Director',
+ 'I2V-01-Director': 'I2V-01-Director',
+ 'S2V-01': 'S2V-01',
+ 'I2V-01': 'I2V-01',
+ 'I2V-01-live': 'I2V-01-live',
+ 'T2V-01': 'T2V-01',
} as const;
/**
* Video resolution. Only available for MiniMax-Hailuo-02.
*/
-export type MinimaxVideoGenerationRequestResolution =
- (typeof MinimaxVideoGenerationRequestResolution)[keyof typeof MinimaxVideoGenerationRequestResolution];
+export type MinimaxVideoGenerationRequestResolution = typeof MinimaxVideoGenerationRequestResolution[keyof typeof MinimaxVideoGenerationRequestResolution];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const MinimaxVideoGenerationRequestResolution = {
- "768P": "768P",
- "1080P": "1080P",
+ '768P': '768P',
+ '1080P': '1080P',
} as const;
export type MinimaxVideoGenerationRequestSubjectReferenceItem = {
- /** URL or base64 encoding of the subject reference image. */
- image?: string;
- /** URL or base64 encoding of the mask for the subject reference image. */
- mask?: string;
+ /** URL or base64 encoding of the subject reference image. */
+ image?: string;
+ /** URL or base64 encoding of the mask for the subject reference image. */
+ mask?: string;
};
/**
* Parameters for the Minimax video generation proxy request.
*/
export interface MinimaxVideoGenerationRequest {
- /** Optional. URL to receive real-time status updates about the video generation task. */
- callback_url?: string;
- /** Video length in seconds. Only available for MiniMax-Hailuo-02 */
- duration?: MinimaxVideoGenerationRequestDuration;
- /** URL or base64 encoding of the first frame image. Required when model is I2V-01, I2V-01-Director, or I2V-01-live. */
- first_frame_image?: string;
- /** Required. ID of model. Options: MiniMax-Hailuo-02, T2V-01-Director, I2V-01-Director, S2V-01, I2V-01, I2V-01-live, T2V-01 */
- model: MinimaxVideoGenerationRequestModel;
- /**
- * Description of the video. Should be less than 2000 characters. Supports camera movement instructions in [brackets].
- * @maxLength 2000
- */
- prompt?: string;
- /** If true (default), the model will automatically optimize the prompt. Set to false for more precise control. */
- prompt_optimizer?: boolean;
- /** Video resolution. Only available for MiniMax-Hailuo-02. */
- resolution?: MinimaxVideoGenerationRequestResolution;
- /** Only available when model is S2V-01. The model will generate a video based on the subject uploaded through this parameter. */
- subject_reference?: MinimaxVideoGenerationRequestSubjectReferenceItem[];
+ /** Optional. URL to receive real-time status updates about the video generation task. */
+ callback_url?: string;
+ /** Video length in seconds. Only available for MiniMax-Hailuo-02 */
+ duration?: MinimaxVideoGenerationRequestDuration;
+ /** URL or base64 encoding of the first frame image. Required when model is I2V-01, I2V-01-Director, or I2V-01-live. */
+ first_frame_image?: string;
+ /** Required. ID of model. Options: MiniMax-Hailuo-02, T2V-01-Director, I2V-01-Director, S2V-01, I2V-01, I2V-01-live, T2V-01 */
+ model: MinimaxVideoGenerationRequestModel;
+ /**
+ * Description of the video. Should be less than 2000 characters. Supports camera movement instructions in [brackets].
+ * @maxLength 2000
+ */
+ prompt?: string;
+ /** If true (default), the model will automatically optimize the prompt. Set to false for more precise control. */
+ prompt_optimizer?: boolean;
+ /** Video resolution. Only available for MiniMax-Hailuo-02. */
+ resolution?: MinimaxVideoGenerationRequestResolution;
+ /** Only available when model is S2V-01. The model will generate a video based on the subject uploaded through this parameter. */
+ subject_reference?: MinimaxVideoGenerationRequestSubjectReferenceItem[];
}
/**
* Response from the Minimax video generation API.
*/
export interface MinimaxVideoGenerationResponse {
- base_resp: MinimaxBaseResponse;
- /** The task ID for the asynchronous video generation task. */
- task_id: string;
+ base_resp: MinimaxBaseResponse;
+ /** The task ID for the asynchronous video generation task. */
+ task_id: string;
}
/**
* Type of input or output content modality.
*/
-export type Modality = (typeof Modality)[keyof typeof Modality];
+export type Modality = typeof Modality[keyof typeof Modality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Modality = {
- MODALITY_UNSPECIFIED: "MODALITY_UNSPECIFIED",
- TEXT: "TEXT",
- IMAGE: "IMAGE",
- VIDEO: "VIDEO",
- AUDIO: "AUDIO",
- DOCUMENT: "DOCUMENT",
+ MODALITY_UNSPECIFIED: 'MODALITY_UNSPECIFIED',
+ TEXT: 'TEXT',
+ IMAGE: 'IMAGE',
+ VIDEO: 'VIDEO',
+ AUDIO: 'AUDIO',
+ DOCUMENT: 'DOCUMENT',
} as const;
export interface ModalityTokenCount {
- modality?: Modality;
- /** Number of tokens for the given modality. */
- tokenCount?: number;
+ modality?: Modality;
+ /** Number of tokens for the given modality. */
+ tokenCount?: number;
}
/**
* How to handle truncation of the response
*/
-export type ModelResponsePropertiesTruncation =
- (typeof ModelResponsePropertiesTruncation)[keyof typeof ModelResponsePropertiesTruncation];
+export type ModelResponsePropertiesTruncation = typeof ModelResponsePropertiesTruncation[keyof typeof ModelResponsePropertiesTruncation];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ModelResponsePropertiesTruncation = {
- disabled: "disabled",
- auto: "auto",
+ disabled: 'disabled',
+ auto: 'auto',
} as const;
/**
* Common properties for model responses
*/
export interface ModelResponseProperties {
- /** Instructions for the model on how to generate the response */
- instructions?: string;
- /** Maximum number of tokens to generate */
- max_output_tokens?: number;
- /** The model used to generate the response */
- model?: string;
- /**
- * Controls randomness in the response
- * @minimum 0
- * @maximum 2
- */
- temperature?: number;
- /**
- * Controls diversity of the response via nucleus sampling
- * @minimum 0
- * @maximum 1
- */
- top_p?: number;
- /** How to handle truncation of the response */
- truncation?: ModelResponsePropertiesTruncation;
-}
-
-export type MoonvalleyImageToVideoRequestAllOfKeyframes = {
- [key: string]: {
- image_url?: string;
- };
-};
+ /** Instructions for the model on how to generate the response */
+ instructions?: string;
+ /** Maximum number of tokens to generate */
+ max_output_tokens?: number;
+ /** The model used to generate the response */
+ model?: string;
+ /**
+ * Controls randomness in the response
+ * @minimum 0
+ * @maximum 2
+ */
+ temperature?: number;
+ /**
+ * Controls diversity of the response via nucleus sampling
+ * @minimum 0
+ * @maximum 1
+ */
+ top_p?: number;
+ /** How to handle truncation of the response */
+ truncation?: ModelResponsePropertiesTruncation;
+}
+
+export type MoonvalleyImageToVideoRequestAllOfKeyframes = {[key: string]: {
+ image_url?: string;
+}};
export type MoonvalleyImageToVideoRequestAllOf = {
- keyframes?: MoonvalleyImageToVideoRequestAllOfKeyframes;
+ keyframes?: MoonvalleyImageToVideoRequestAllOfKeyframes;
};
-export type MoonvalleyImageToVideoRequest = MoonvalleyTextToVideoRequest &
- MoonvalleyImageToVideoRequestAllOf;
+export type MoonvalleyImageToVideoRequest = MoonvalleyTextToVideoRequest & MoonvalleyImageToVideoRequestAllOf;
export type MoonvalleyPromptResponseError = { [key: string]: unknown };
-export type MoonvalleyPromptResponseFrameConditioning = {
- [key: string]: unknown;
-};
+export type MoonvalleyPromptResponseFrameConditioning = { [key: string]: unknown };
-export type MoonvalleyPromptResponseInferenceParams = {
- [key: string]: unknown;
-};
+export type MoonvalleyPromptResponseInferenceParams = { [key: string]: unknown };
export type MoonvalleyPromptResponseMeta = { [key: string]: unknown };
export type MoonvalleyPromptResponseModelParams = { [key: string]: unknown };
export interface MoonvalleyPromptResponse {
- error?: MoonvalleyPromptResponseError;
- frame_conditioning?: MoonvalleyPromptResponseFrameConditioning;
- id?: string;
- inference_params?: MoonvalleyPromptResponseInferenceParams;
- meta?: MoonvalleyPromptResponseMeta;
- model_params?: MoonvalleyPromptResponseModelParams;
- output_url?: string;
- prompt_text?: string;
- status?: string;
+ error?: MoonvalleyPromptResponseError;
+ frame_conditioning?: MoonvalleyPromptResponseFrameConditioning;
+ id?: string;
+ inference_params?: MoonvalleyPromptResponseInferenceParams;
+ meta?: MoonvalleyPromptResponseMeta;
+ model_params?: MoonvalleyPromptResponseModelParams;
+ output_url?: string;
+ prompt_text?: string;
+ status?: string;
}
export type MoonvalleyResizeVideoRequestAllOf = {
- /**
- * @minItems 2
- * @maxItems 2
- */
- frame_position?: number[];
- /**
- * @minItems 2
- * @maxItems 2
- */
- frame_resolution?: number[];
- /**
- * @minItems 2
- * @maxItems 2
- */
- scale?: number[];
+ /**
+ * @minItems 2
+ * @maxItems 2
+ */
+ frame_position?: number[];
+ /**
+ * @minItems 2
+ * @maxItems 2
+ */
+ frame_resolution?: number[];
+ /**
+ * @minItems 2
+ * @maxItems 2
+ */
+ scale?: number[];
};
-export type MoonvalleyResizeVideoRequest = MoonvalleyVideoToVideoRequest &
- MoonvalleyResizeVideoRequestAllOf;
+export type MoonvalleyResizeVideoRequest = MoonvalleyVideoToVideoRequest & MoonvalleyResizeVideoRequestAllOf;
export interface MoonvalleyTextToImageRequest {
- image_url?: string;
- inference_params?: MoonvalleyTextToVideoInferenceParams;
- prompt_text?: string;
- webhook_url?: string;
+ image_url?: string;
+ inference_params?: MoonvalleyTextToVideoInferenceParams;
+ prompt_text?: string;
+ webhook_url?: string;
}
export interface MoonvalleyTextToVideoInferenceParams {
- /** Guidance scale for generation control */
- guidance_scale?: number;
- /** Height of the generated video in pixels */
- height?: number;
- /** Negative prompt text */
- negative_prompt?: string;
- /** Random seed for generation (default: random) */
- seed?: number;
- /** Number of denoising steps */
- steps?: number;
- /** Whether to use negative prompts */
- use_negative_prompts?: boolean;
- /** Width of the generated video in pixels */
- width?: number;
+ /** Guidance scale for generation control */
+ guidance_scale?: number;
+ /** Height of the generated video in pixels */
+ height?: number;
+ /** Negative prompt text */
+ negative_prompt?: string;
+ /** Random seed for generation (default: random) */
+ seed?: number;
+ /** Number of denoising steps */
+ steps?: number;
+ /** Whether to use negative prompts */
+ use_negative_prompts?: boolean;
+ /** Width of the generated video in pixels */
+ width?: number;
}
export interface MoonvalleyTextToVideoRequest {
- image_url?: string;
- inference_params?: MoonvalleyTextToVideoInferenceParams;
- prompt_text?: string;
- webhook_url?: string;
+ image_url?: string;
+ inference_params?: MoonvalleyTextToVideoInferenceParams;
+ prompt_text?: string;
+ webhook_url?: string;
}
export interface MoonvalleyUploadFileRequest {
- file?: Blob;
+ file?: Blob;
}
export interface MoonvalleyUploadFileResponse {
- access_url?: string;
+ access_url?: string;
}
export type MoonvalleyVideoToVideoInferenceParamsControlParams = {
- /** Intensity of motion control */
- motion_intensity?: number;
+ /** Intensity of motion control */
+ motion_intensity?: number;
};
export interface MoonvalleyVideoToVideoInferenceParams {
- control_params?: MoonvalleyVideoToVideoInferenceParamsControlParams;
- /** Guidance scale for generation control */
- guidance_scale?: number;
- /** Negative prompt text */
- negative_prompt?: string;
- /** Random seed for generation (default: random) */
- seed?: number;
- /** Number of denoising steps */
- steps?: number;
- /** Whether to use negative prompts */
- use_negative_prompts?: boolean;
+ control_params?: MoonvalleyVideoToVideoInferenceParamsControlParams;
+ /** Guidance scale for generation control */
+ guidance_scale?: number;
+ /** Negative prompt text */
+ negative_prompt?: string;
+ /** Random seed for generation (default: random) */
+ seed?: number;
+ /** Number of denoising steps */
+ steps?: number;
+ /** Whether to use negative prompts */
+ use_negative_prompts?: boolean;
}
/**
* Supported types for video control
*/
-export type MoonvalleyVideoToVideoRequestControlType =
- (typeof MoonvalleyVideoToVideoRequestControlType)[keyof typeof MoonvalleyVideoToVideoRequestControlType];
+export type MoonvalleyVideoToVideoRequestControlType = typeof MoonvalleyVideoToVideoRequestControlType[keyof typeof MoonvalleyVideoToVideoRequestControlType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const MoonvalleyVideoToVideoRequestControlType = {
- motion_control: "motion_control",
- pose_control: "pose_control",
+ motion_control: 'motion_control',
+ pose_control: 'pose_control',
} as const;
export interface MoonvalleyVideoToVideoRequest {
- /** Supported types for video control */
- control_type: MoonvalleyVideoToVideoRequestControlType;
- /** Url to control image */
- image_url?: string;
- inference_params?: MoonvalleyVideoToVideoInferenceParams;
- /** Describes the video to generate */
- prompt_text: string;
- /** Url to control video */
- video_url: string;
- /** Optional webhook URL for notifications */
- webhook_url?: string;
+ /** Supported types for video control */
+ control_type: MoonvalleyVideoToVideoRequestControlType;
+ /** Url to control image */
+ image_url?: string;
+ inference_params?: MoonvalleyVideoToVideoInferenceParams;
+ /** Describes the video to generate */
+ prompt_text: string;
+ /** Url to control video */
+ video_url: string;
+ /** Optional webhook URL for notifications */
+ webhook_url?: string;
}
/**
* Translations of node metadata in different languages.
*/
-export type NodeTranslations = { [key: string]: { [key: string]: unknown } };
+export type NodeTranslations = {[key: string]: { [key: string]: unknown }};
export interface Node {
- author?: string;
- /** URL to the node's banner. */
- banner_url?: string;
- /** The category of the node. */
- category?: string;
- /** The date and time when the node was created */
- created_at?: string;
- description?: string;
- /** The number of downloads of the node. */
- downloads?: number;
- /** Number of stars on the GitHub repository. */
- github_stars?: number;
- /** URL to the node's icon. */
- icon?: string;
- /** The unique identifier of the node. */
- id?: string;
- latest_version?: NodeVersion;
- /** The path to the LICENSE file in the node's repository. */
- license?: string;
- /** The display name of the node. */
- name?: string;
- /** A list of Comfy node names that are preempted by this node. */
- preempted_comfy_node_names?: string[];
- publisher?: Publisher;
- /** The average rating of the node. */
- rating?: number;
- /** URL to the node's repository. */
- repository?: string;
- /** A numerical value representing the node's search ranking, used for sorting search results. */
- search_ranking?: number;
- status?: NodeStatus;
- /** The status detail of the node. */
- status_detail?: string;
- /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
- supported_accelerators?: string[];
- /** Supported versions of ComfyUI frontend */
- supported_comfyui_frontend_version?: string;
- /** Supported versions of ComfyUI */
- supported_comfyui_version?: string;
- /** List of operating systems that this node supports */
- supported_os?: string[];
- tags?: string[];
- /** Translations of node metadata in different languages. */
- translations?: NodeTranslations;
-}
-
-export type NodeStatus = (typeof NodeStatus)[keyof typeof NodeStatus];
+ author?: string;
+ /** URL to the node's banner. */
+ banner_url?: string;
+ /**
+ * DEPRECATED: The category of the node. Use 'tags' field instead. This field will be removed in a future version.
+ * @deprecated
+ */
+ category?: string;
+ /** The date and time when the node was created */
+ created_at?: string;
+ description?: string;
+ /** The number of downloads of the node. */
+ downloads?: number;
+ /** Number of stars on the GitHub repository. */
+ github_stars?: number;
+ /** URL to the node's icon. */
+ icon?: string;
+ /** The unique identifier of the node. */
+ id?: string;
+ latest_version?: NodeVersion;
+ /** The path to the LICENSE file in the node's repository. */
+ license?: string;
+ /** The display name of the node. */
+ name?: string;
+ /** A list of Comfy node names that are preempted by this node. */
+ preempted_comfy_node_names?: string[];
+ publisher?: Publisher;
+ /** The average rating of the node. */
+ rating?: number;
+ /** URL to the node's repository. */
+ repository?: string;
+ /** A numerical value representing the node's search ranking, used for sorting search results. */
+ search_ranking?: number;
+ status?: NodeStatus;
+ /** The status detail of the node. */
+ status_detail?: string;
+ /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
+ supported_accelerators?: string[];
+ /** Supported versions of ComfyUI frontend */
+ supported_comfyui_frontend_version?: string;
+ /** Supported versions of ComfyUI */
+ supported_comfyui_version?: string;
+ /** List of operating systems that this node supports */
+ supported_os?: string[];
+ tags?: string[];
+ /** Admin-only tags for security warnings and admin metadata */
+ tags_admin?: string[];
+ /** Translations of node metadata in different languages. */
+ translations?: NodeTranslations;
+}
+
+export type NodeStatus = typeof NodeStatus[keyof typeof NodeStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const NodeStatus = {
- NodeStatusActive: "NodeStatusActive",
- NodeStatusDeleted: "NodeStatusDeleted",
- NodeStatusBanned: "NodeStatusBanned",
+ NodeStatusActive: 'NodeStatusActive',
+ NodeStatusDeleted: 'NodeStatusDeleted',
+ NodeStatusBanned: 'NodeStatusBanned',
} as const;
export interface NodeVersion {
- /** Summary of changes made in this version */
- changelog?: string;
- /** The status of comfy node extraction process. */
- comfy_node_extract_status?: string;
- /** The date and time the version was created. */
- createdAt?: string;
- /** A list of pip dependencies required by the node. */
- dependencies?: string[];
- /** Indicates if this version is deprecated. */
- deprecated?: boolean;
- /** [Output Only] URL to download this version of the node */
- downloadUrl?: string;
- id?: string;
- /** The unique identifier of the node. */
- node_id?: string;
- status?: NodeVersionStatus;
- /** The reason for the status change. */
- status_reason?: string;
- /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
- supported_accelerators?: string[];
- /** Supported versions of ComfyUI frontend */
- supported_comfyui_frontend_version?: string;
- /** Supported versions of ComfyUI */
- supported_comfyui_version?: string;
- /** List of operating systems that this node supports */
- supported_os?: string[];
- /** The version identifier, following semantic versioning. Must be unique for the node. */
- version?: string;
+ /** Summary of changes made in this version */
+ changelog?: string;
+ /** The status of comfy node extraction process. */
+ comfy_node_extract_status?: string;
+ /** The date and time the version was created. */
+ createdAt?: string;
+ /** A list of pip dependencies required by the node. */
+ dependencies?: string[];
+ /** Indicates if this version is deprecated. */
+ deprecated?: boolean;
+ /** [Output Only] URL to download this version of the node */
+ downloadUrl?: string;
+ id?: string;
+ /** The unique identifier of the node. */
+ node_id?: string;
+ status?: NodeVersionStatus;
+ status_reason?: string;
+ /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
+ supported_accelerators?: string[];
+ /** Supported versions of ComfyUI frontend */
+ supported_comfyui_frontend_version?: string;
+ /** Supported versions of ComfyUI */
+ supported_comfyui_version?: string;
+ /** List of operating systems that this node supports */
+ supported_os?: string[];
+ tags?: string[];
+ /** Admin-only tags for security warnings and admin metadata */
+ tags_admin?: string[];
+ /** The version identifier, following semantic versioning. Must be unique for the node. */
+ version?: string;
}
export interface NodeVersionIdentifier {
- /** The unique identifier of the node */
- node_id: string;
- /** The version of the node */
- version: string;
+ /** The unique identifier of the node */
+ node_id: string;
+ /** The version of the node */
+ version: string;
}
-export type NodeVersionStatus =
- (typeof NodeVersionStatus)[keyof typeof NodeVersionStatus];
+export type NodeVersionStatus = typeof NodeVersionStatus[keyof typeof NodeVersionStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const NodeVersionStatus = {
- NodeVersionStatusActive: "NodeVersionStatusActive",
- NodeVersionStatusDeleted: "NodeVersionStatusDeleted",
- NodeVersionStatusBanned: "NodeVersionStatusBanned",
- NodeVersionStatusPending: "NodeVersionStatusPending",
- NodeVersionStatusFlagged: "NodeVersionStatusFlagged",
+ NodeVersionStatusActive: 'NodeVersionStatusActive',
+ NodeVersionStatusDeleted: 'NodeVersionStatusDeleted',
+ NodeVersionStatusBanned: 'NodeVersionStatusBanned',
+ NodeVersionStatusPending: 'NodeVersionStatusPending',
+ NodeVersionStatusFlagged: 'NodeVersionStatusFlagged',
} as const;
export interface NodeVersionUpdateRequest {
- /** The changelog describing the version changes. */
- changelog?: string;
- /** Whether the version is deprecated. */
- deprecated?: boolean;
+ /** The changelog describing the version changes. */
+ changelog?: string;
+ /** Whether the version is deprecated. */
+ deprecated?: boolean;
}
/**
@@ -3948,7 +3967,7 @@ Learn more:
export type OpenAICreateResponseAllOfInput = string | InputItem[];
export type OpenAICreateResponseAllOf = {
- /**
+ /**
* Specify additional output data to include in the model response. Currently
supported values are:
- `file_search_call.results`: Include the search results of
@@ -3958,8 +3977,8 @@ supported values are:
* @nullable
*/
- include?: Includable[] | null;
- /** Text, image, or file inputs to the model, used to generate a response.
+ include?: Includable[] | null;
+ /** Text, image, or file inputs to the model, used to generate a response.
Learn more:
- [Text inputs and outputs](/docs/guides/text)
@@ -3968,21 +3987,21 @@ Learn more:
- [Conversation state](/docs/guides/conversation-state)
- [Function calling](/docs/guides/function-calling)
*/
- input: OpenAICreateResponseAllOfInput;
- /**
+ input: OpenAICreateResponseAllOfInput;
+ /**
* Whether to allow the model to run tool calls in parallel.
* @nullable
*/
- parallel_tool_calls?: boolean | null;
- /**
+ parallel_tool_calls?: boolean | null;
+ /**
* Whether to store the generated model response for later retrieval via
API.
* @nullable
*/
- store?: boolean | null;
- /**
+ store?: boolean | null;
+ /**
* If set to true, the model response data will be streamed to the client
as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the [Streaming section below](/docs/api-reference/responses-streaming)
@@ -3990,277 +4009,266 @@ for more information.
* @nullable
*/
- stream?: boolean | null;
- usage?: ResponseUsage;
+ stream?: boolean | null;
+ usage?: ResponseUsage;
};
-export type OpenAICreateResponse = CreateModelResponseProperties &
- ResponseProperties &
- OpenAICreateResponseAllOf &
- Required<
- Pick<
- CreateModelResponseProperties &
- ResponseProperties &
- OpenAICreateResponseAllOf,
- "model"
- >
- >;
+export type OpenAICreateResponse = CreateModelResponseProperties & ResponseProperties & OpenAICreateResponseAllOf & Required>;
/**
* Content moderation setting
*/
-export type OpenAIImageEditRequestModeration =
- (typeof OpenAIImageEditRequestModeration)[keyof typeof OpenAIImageEditRequestModeration];
+export type OpenAIImageEditRequestModeration = typeof OpenAIImageEditRequestModeration[keyof typeof OpenAIImageEditRequestModeration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageEditRequestModeration = {
- low: "low",
- auto: "auto",
+ low: 'low',
+ auto: 'auto',
} as const;
/**
* Format of the output image
*/
-export type OpenAIImageEditRequestOutputFormat =
- (typeof OpenAIImageEditRequestOutputFormat)[keyof typeof OpenAIImageEditRequestOutputFormat];
+export type OpenAIImageEditRequestOutputFormat = typeof OpenAIImageEditRequestOutputFormat[keyof typeof OpenAIImageEditRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageEditRequestOutputFormat = {
- png: "png",
- webp: "webp",
- jpeg: "jpeg",
+ png: 'png',
+ webp: 'webp',
+ jpeg: 'jpeg',
} as const;
export interface OpenAIImageEditRequest {
- /** Background transparency */
- background?: string;
- /** The model to use for image editing */
- model: string;
- /** Content moderation setting */
- moderation?: OpenAIImageEditRequestModeration;
- /** The number of images to generate */
- n?: number;
- /** Compression level for JPEG or WebP (0-100) */
- output_compression?: number;
- /** Format of the output image */
- output_format?: OpenAIImageEditRequestOutputFormat;
- /** A text description of the desired edit */
- prompt: string;
- /** The quality of the edited image */
- quality?: string;
- /** Size of the output image */
- size?: string;
- /** A unique identifier for end-user monitoring */
- user?: string;
+ /** Background transparency */
+ background?: string;
+ /** The model to use for image editing */
+ model: string;
+ /** Content moderation setting */
+ moderation?: OpenAIImageEditRequestModeration;
+ /** The number of images to generate */
+ n?: number;
+ /** Compression level for JPEG or WebP (0-100) */
+ output_compression?: number;
+ /** Format of the output image */
+ output_format?: OpenAIImageEditRequestOutputFormat;
+ /** A text description of the desired edit */
+ prompt: string;
+ /** The quality of the edited image */
+ quality?: string;
+ /** Size of the output image */
+ size?: string;
+ /** A unique identifier for end-user monitoring */
+ user?: string;
}
/**
* Background transparency
*/
-export type OpenAIImageGenerationRequestBackground =
- (typeof OpenAIImageGenerationRequestBackground)[keyof typeof OpenAIImageGenerationRequestBackground];
+export type OpenAIImageGenerationRequestBackground = typeof OpenAIImageGenerationRequestBackground[keyof typeof OpenAIImageGenerationRequestBackground];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestBackground = {
- transparent: "transparent",
- opaque: "opaque",
+ transparent: 'transparent',
+ opaque: 'opaque',
} as const;
/**
* Content moderation setting
*/
-export type OpenAIImageGenerationRequestModeration =
- (typeof OpenAIImageGenerationRequestModeration)[keyof typeof OpenAIImageGenerationRequestModeration];
+export type OpenAIImageGenerationRequestModeration = typeof OpenAIImageGenerationRequestModeration[keyof typeof OpenAIImageGenerationRequestModeration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestModeration = {
- low: "low",
- auto: "auto",
+ low: 'low',
+ auto: 'auto',
} as const;
/**
* Format of the output image
*/
-export type OpenAIImageGenerationRequestOutputFormat =
- (typeof OpenAIImageGenerationRequestOutputFormat)[keyof typeof OpenAIImageGenerationRequestOutputFormat];
+export type OpenAIImageGenerationRequestOutputFormat = typeof OpenAIImageGenerationRequestOutputFormat[keyof typeof OpenAIImageGenerationRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestOutputFormat = {
- png: "png",
- webp: "webp",
- jpeg: "jpeg",
+ png: 'png',
+ webp: 'webp',
+ jpeg: 'jpeg',
} as const;
/**
* The quality of the generated image
*/
-export type OpenAIImageGenerationRequestQuality =
- (typeof OpenAIImageGenerationRequestQuality)[keyof typeof OpenAIImageGenerationRequestQuality];
+export type OpenAIImageGenerationRequestQuality = typeof OpenAIImageGenerationRequestQuality[keyof typeof OpenAIImageGenerationRequestQuality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestQuality = {
- low: "low",
- medium: "medium",
- high: "high",
- standard: "standard",
- hd: "hd",
+ low: 'low',
+ medium: 'medium',
+ high: 'high',
+ standard: 'standard',
+ hd: 'hd',
} as const;
/**
* Response format of image data
*/
-export type OpenAIImageGenerationRequestResponseFormat =
- (typeof OpenAIImageGenerationRequestResponseFormat)[keyof typeof OpenAIImageGenerationRequestResponseFormat];
+export type OpenAIImageGenerationRequestResponseFormat = typeof OpenAIImageGenerationRequestResponseFormat[keyof typeof OpenAIImageGenerationRequestResponseFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestResponseFormat = {
- url: "url",
- b64_json: "b64_json",
+ url: 'url',
+ b64_json: 'b64_json',
} as const;
/**
* Style of the image (only for dall-e-3)
*/
-export type OpenAIImageGenerationRequestStyle =
- (typeof OpenAIImageGenerationRequestStyle)[keyof typeof OpenAIImageGenerationRequestStyle];
+export type OpenAIImageGenerationRequestStyle = typeof OpenAIImageGenerationRequestStyle[keyof typeof OpenAIImageGenerationRequestStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIImageGenerationRequestStyle = {
- vivid: "vivid",
- natural: "natural",
+ vivid: 'vivid',
+ natural: 'natural',
} as const;
export interface OpenAIImageGenerationRequest {
- /** Background transparency */
- background?: OpenAIImageGenerationRequestBackground;
- /** The model to use for image generation */
- model?: string;
- /** Content moderation setting */
- moderation?: OpenAIImageGenerationRequestModeration;
- /** The number of images to generate (1-10). Only 1 supported for dall-e-3. */
- n?: number;
- /** Compression level for JPEG or WebP (0-100) */
- output_compression?: number;
- /** Format of the output image */
- output_format?: OpenAIImageGenerationRequestOutputFormat;
- /** A text description of the desired image */
- prompt: string;
- /** The quality of the generated image */
- quality?: OpenAIImageGenerationRequestQuality;
- /** Response format of image data */
- response_format?: OpenAIImageGenerationRequestResponseFormat;
- /** Size of the image (e.g., 1024x1024, 1536x1024, auto) */
- size?: string;
- /** Style of the image (only for dall-e-3) */
- style?: OpenAIImageGenerationRequestStyle;
- /** A unique identifier for end-user monitoring */
- user?: string;
+ /** Background transparency */
+ background?: OpenAIImageGenerationRequestBackground;
+ /** The model to use for image generation */
+ model?: string;
+ /** Content moderation setting */
+ moderation?: OpenAIImageGenerationRequestModeration;
+ /** The number of images to generate (1-10). Only 1 supported for dall-e-3. */
+ n?: number;
+ /** Compression level for JPEG or WebP (0-100) */
+ output_compression?: number;
+ /** Format of the output image */
+ output_format?: OpenAIImageGenerationRequestOutputFormat;
+ /** A text description of the desired image */
+ prompt: string;
+ /** The quality of the generated image */
+ quality?: OpenAIImageGenerationRequestQuality;
+ /** Response format of image data */
+ response_format?: OpenAIImageGenerationRequestResponseFormat;
+ /** Size of the image (e.g., 1024x1024, 1536x1024, auto) */
+ size?: string;
+ /** Style of the image (only for dall-e-3) */
+ style?: OpenAIImageGenerationRequestStyle;
+ /** A unique identifier for end-user monitoring */
+ user?: string;
}
export type OpenAIImageGenerationResponseDataItem = {
- /** Base64 encoded image data */
- b64_json?: string;
- /** Revised prompt */
- revised_prompt?: string;
- /** URL of the image */
- url?: string;
+ /** Base64 encoded image data */
+ b64_json?: string;
+ /** Revised prompt */
+ revised_prompt?: string;
+ /** URL of the image */
+ url?: string;
};
export type OpenAIImageGenerationResponseUsageInputTokensDetails = {
- image_tokens?: number;
- text_tokens?: number;
+ image_tokens?: number;
+ text_tokens?: number;
};
export type OpenAIImageGenerationResponseUsage = {
- input_tokens?: number;
- input_tokens_details?: OpenAIImageGenerationResponseUsageInputTokensDetails;
- output_tokens?: number;
- total_tokens?: number;
+ input_tokens?: number;
+ input_tokens_details?: OpenAIImageGenerationResponseUsageInputTokensDetails;
+ output_tokens?: number;
+ total_tokens?: number;
};
export interface OpenAIImageGenerationResponse {
- data?: OpenAIImageGenerationResponseDataItem[];
- usage?: OpenAIImageGenerationResponseUsage;
+ data?: OpenAIImageGenerationResponseDataItem[];
+ usage?: OpenAIImageGenerationResponseUsage;
}
-export type OpenAIModels = (typeof OpenAIModels)[keyof typeof OpenAIModels];
+export type OpenAIModels = typeof OpenAIModels[keyof typeof OpenAIModels];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIModels = {
- "gpt-4": "gpt-4",
- "gpt-4-0314": "gpt-4-0314",
- "gpt-4-0613": "gpt-4-0613",
- "gpt-4-32k": "gpt-4-32k",
- "gpt-4-32k-0314": "gpt-4-32k-0314",
- "gpt-4-32k-0613": "gpt-4-32k-0613",
- "gpt-4-0125-preview": "gpt-4-0125-preview",
- "gpt-4-turbo": "gpt-4-turbo",
- "gpt-4-turbo-2024-04-09": "gpt-4-turbo-2024-04-09",
- "gpt-4-turbo-preview": "gpt-4-turbo-preview",
- "gpt-4-1106-preview": "gpt-4-1106-preview",
- "gpt-4-vision-preview": "gpt-4-vision-preview",
- "gpt-35-turbo": "gpt-3.5-turbo",
- "gpt-35-turbo-16k": "gpt-3.5-turbo-16k",
- "gpt-35-turbo-0301": "gpt-3.5-turbo-0301",
- "gpt-35-turbo-0613": "gpt-3.5-turbo-0613",
- "gpt-35-turbo-1106": "gpt-3.5-turbo-1106",
- "gpt-35-turbo-0125": "gpt-3.5-turbo-0125",
- "gpt-35-turbo-16k-0613": "gpt-3.5-turbo-16k-0613",
- "gpt-41": "gpt-4.1",
- "gpt-41-mini": "gpt-4.1-mini",
- "gpt-41-nano": "gpt-4.1-nano",
- "gpt-41-2025-04-14": "gpt-4.1-2025-04-14",
- "gpt-41-mini-2025-04-14": "gpt-4.1-mini-2025-04-14",
- "gpt-41-nano-2025-04-14": "gpt-4.1-nano-2025-04-14",
- o1: "o1",
- "o1-mini": "o1-mini",
- "o1-preview": "o1-preview",
- "o1-pro": "o1-pro",
- "o1-2024-12-17": "o1-2024-12-17",
- "o1-preview-2024-09-12": "o1-preview-2024-09-12",
- "o1-mini-2024-09-12": "o1-mini-2024-09-12",
- "o1-pro-2025-03-19": "o1-pro-2025-03-19",
- o3: "o3",
- "o3-mini": "o3-mini",
- "o3-2025-04-16": "o3-2025-04-16",
- "o3-mini-2025-01-31": "o3-mini-2025-01-31",
- "o4-mini": "o4-mini",
- "o4-mini-2025-04-16": "o4-mini-2025-04-16",
- "gpt-4o": "gpt-4o",
- "gpt-4o-mini": "gpt-4o-mini",
- "gpt-4o-2024-11-20": "gpt-4o-2024-11-20",
- "gpt-4o-2024-08-06": "gpt-4o-2024-08-06",
- "gpt-4o-2024-05-13": "gpt-4o-2024-05-13",
- "gpt-4o-mini-2024-07-18": "gpt-4o-mini-2024-07-18",
- "gpt-4o-audio-preview": "gpt-4o-audio-preview",
- "gpt-4o-audio-preview-2024-10-01": "gpt-4o-audio-preview-2024-10-01",
- "gpt-4o-audio-preview-2024-12-17": "gpt-4o-audio-preview-2024-12-17",
- "gpt-4o-mini-audio-preview": "gpt-4o-mini-audio-preview",
- "gpt-4o-mini-audio-preview-2024-12-17":
- "gpt-4o-mini-audio-preview-2024-12-17",
- "gpt-4o-search-preview": "gpt-4o-search-preview",
- "gpt-4o-mini-search-preview": "gpt-4o-mini-search-preview",
- "gpt-4o-search-preview-2025-03-11": "gpt-4o-search-preview-2025-03-11",
- "gpt-4o-mini-search-preview-2025-03-11":
- "gpt-4o-mini-search-preview-2025-03-11",
- "computer-use-preview": "computer-use-preview",
- "computer-use-preview-2025-03-11": "computer-use-preview-2025-03-11",
- "gpt-5": "gpt-5",
- "gpt-5-mini": "gpt-5-mini",
- "gpt-5-nano": "gpt-5-nano",
- "chatgpt-4o-latest": "chatgpt-4o-latest",
+ 'gpt-4': 'gpt-4',
+ 'gpt-4-0314': 'gpt-4-0314',
+ 'gpt-4-0613': 'gpt-4-0613',
+ 'gpt-4-32k': 'gpt-4-32k',
+ 'gpt-4-32k-0314': 'gpt-4-32k-0314',
+ 'gpt-4-32k-0613': 'gpt-4-32k-0613',
+ 'gpt-4-0125-preview': 'gpt-4-0125-preview',
+ 'gpt-4-turbo': 'gpt-4-turbo',
+ 'gpt-4-turbo-2024-04-09': 'gpt-4-turbo-2024-04-09',
+ 'gpt-4-turbo-preview': 'gpt-4-turbo-preview',
+ 'gpt-4-1106-preview': 'gpt-4-1106-preview',
+ 'gpt-4-vision-preview': 'gpt-4-vision-preview',
+ 'gpt-35-turbo': 'gpt-3.5-turbo',
+ 'gpt-35-turbo-16k': 'gpt-3.5-turbo-16k',
+ 'gpt-35-turbo-0301': 'gpt-3.5-turbo-0301',
+ 'gpt-35-turbo-0613': 'gpt-3.5-turbo-0613',
+ 'gpt-35-turbo-1106': 'gpt-3.5-turbo-1106',
+ 'gpt-35-turbo-0125': 'gpt-3.5-turbo-0125',
+ 'gpt-35-turbo-16k-0613': 'gpt-3.5-turbo-16k-0613',
+ 'gpt-41': 'gpt-4.1',
+ 'gpt-41-mini': 'gpt-4.1-mini',
+ 'gpt-41-nano': 'gpt-4.1-nano',
+ 'gpt-41-2025-04-14': 'gpt-4.1-2025-04-14',
+ 'gpt-41-mini-2025-04-14': 'gpt-4.1-mini-2025-04-14',
+ 'gpt-41-nano-2025-04-14': 'gpt-4.1-nano-2025-04-14',
+ o1: 'o1',
+ 'o1-mini': 'o1-mini',
+ 'o1-preview': 'o1-preview',
+ 'o1-pro': 'o1-pro',
+ 'o1-2024-12-17': 'o1-2024-12-17',
+ 'o1-preview-2024-09-12': 'o1-preview-2024-09-12',
+ 'o1-mini-2024-09-12': 'o1-mini-2024-09-12',
+ 'o1-pro-2025-03-19': 'o1-pro-2025-03-19',
+ o3: 'o3',
+ 'o3-mini': 'o3-mini',
+ 'o3-2025-04-16': 'o3-2025-04-16',
+ 'o3-mini-2025-01-31': 'o3-mini-2025-01-31',
+ 'o4-mini': 'o4-mini',
+ 'o4-mini-2025-04-16': 'o4-mini-2025-04-16',
+ 'gpt-4o': 'gpt-4o',
+ 'gpt-4o-mini': 'gpt-4o-mini',
+ 'gpt-4o-2024-11-20': 'gpt-4o-2024-11-20',
+ 'gpt-4o-2024-08-06': 'gpt-4o-2024-08-06',
+ 'gpt-4o-2024-05-13': 'gpt-4o-2024-05-13',
+ 'gpt-4o-mini-2024-07-18': 'gpt-4o-mini-2024-07-18',
+ 'gpt-4o-audio-preview': 'gpt-4o-audio-preview',
+ 'gpt-4o-audio-preview-2024-10-01': 'gpt-4o-audio-preview-2024-10-01',
+ 'gpt-4o-audio-preview-2024-12-17': 'gpt-4o-audio-preview-2024-12-17',
+ 'gpt-4o-mini-audio-preview': 'gpt-4o-mini-audio-preview',
+ 'gpt-4o-mini-audio-preview-2024-12-17': 'gpt-4o-mini-audio-preview-2024-12-17',
+ 'gpt-4o-search-preview': 'gpt-4o-search-preview',
+ 'gpt-4o-mini-search-preview': 'gpt-4o-mini-search-preview',
+ 'gpt-4o-search-preview-2025-03-11': 'gpt-4o-search-preview-2025-03-11',
+ 'gpt-4o-mini-search-preview-2025-03-11': 'gpt-4o-mini-search-preview-2025-03-11',
+ 'computer-use-preview': 'computer-use-preview',
+ 'computer-use-preview-2025-03-11': 'computer-use-preview-2025-03-11',
+ 'gpt-5': 'gpt-5',
+ 'gpt-5-mini': 'gpt-5-mini',
+ 'gpt-5-nano': 'gpt-5-nano',
+ 'chatgpt-4o-latest': 'chatgpt-4o-latest',
} as const;
/**
* The reason why the response is incomplete.
*/
-export type OpenAIResponseAllOfIncompleteDetailsReason =
- (typeof OpenAIResponseAllOfIncompleteDetailsReason)[keyof typeof OpenAIResponseAllOfIncompleteDetailsReason];
+export type OpenAIResponseAllOfIncompleteDetailsReason = typeof OpenAIResponseAllOfIncompleteDetailsReason[keyof typeof OpenAIResponseAllOfIncompleteDetailsReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIResponseAllOfIncompleteDetailsReason = {
- max_output_tokens: "max_output_tokens",
- content_filter: "content_filter",
+ max_output_tokens: 'max_output_tokens',
+ content_filter: 'content_filter',
} as const;
/**
@@ -4269,50 +4277,50 @@ export const OpenAIResponseAllOfIncompleteDetailsReason = {
* @nullable
*/
export type OpenAIResponseAllOfIncompleteDetails = {
- /** The reason why the response is incomplete. */
- reason?: OpenAIResponseAllOfIncompleteDetailsReason;
+ /** The reason why the response is incomplete. */
+ reason?: OpenAIResponseAllOfIncompleteDetailsReason;
} | null;
/**
* The object type of this resource - always set to `response`.
*/
-export type OpenAIResponseAllOfObject =
- (typeof OpenAIResponseAllOfObject)[keyof typeof OpenAIResponseAllOfObject];
+export type OpenAIResponseAllOfObject = typeof OpenAIResponseAllOfObject[keyof typeof OpenAIResponseAllOfObject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIResponseAllOfObject = {
- response: "response",
+ response: 'response',
} as const;
/**
* The status of the response generation. One of `completed`, `failed`, `in_progress`, or `incomplete`.
*/
-export type OpenAIResponseAllOfStatus =
- (typeof OpenAIResponseAllOfStatus)[keyof typeof OpenAIResponseAllOfStatus];
+export type OpenAIResponseAllOfStatus = typeof OpenAIResponseAllOfStatus[keyof typeof OpenAIResponseAllOfStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OpenAIResponseAllOfStatus = {
- completed: "completed",
- failed: "failed",
- in_progress: "in_progress",
- incomplete: "incomplete",
+ completed: 'completed',
+ failed: 'failed',
+ in_progress: 'in_progress',
+ incomplete: 'incomplete',
} as const;
export type OpenAIResponseAllOf = {
- /** Unix timestamp (in seconds) of when this Response was created. */
- created_at?: number;
- error?: ResponseError;
- /** Unique identifier for this Response. */
- id?: string;
- /**
+ /** Unix timestamp (in seconds) of when this Response was created. */
+ created_at?: number;
+ error?: ResponseError;
+ /** Unique identifier for this Response. */
+ id?: string;
+ /**
* Details about why the response is incomplete.
* @nullable
*/
- incomplete_details?: OpenAIResponseAllOfIncompleteDetails;
- /** The object type of this resource - always set to `response`. */
- object?: OpenAIResponseAllOfObject;
- /** An array of content items generated by the model.
+ incomplete_details?: OpenAIResponseAllOfIncompleteDetails;
+ /** The object type of this resource - always set to `response`. */
+ object?: OpenAIResponseAllOfObject;
+ /** An array of content items generated by the model.
- The length and order of items in the `output` array is dependent
on the model's response.
@@ -4321,522 +4329,621 @@ export type OpenAIResponseAllOf = {
the model, you might consider using the `output_text` property where
supported in SDKs.
*/
- output?: OutputItem[];
- /**
+ output?: OutputItem[];
+ /**
* SDK-only convenience property that contains the aggregated text output
from all `output_text` items in the `output` array, if any are present.
Supported in the Python and JavaScript SDKs.
* @nullable
*/
- output_text?: string | null;
- /** Whether to allow the model to run tool calls in parallel.
- */
- parallel_tool_calls?: boolean;
- /** The status of the response generation. One of `completed`, `failed`, `in_progress`, or `incomplete`. */
- status?: OpenAIResponseAllOfStatus;
- usage?: ResponseUsage;
+ output_text?: string | null;
+ /** Whether to allow the model to run tool calls in parallel.
+ */
+ parallel_tool_calls?: boolean;
+ /** The status of the response generation. One of `completed`, `failed`, `in_progress`, or `incomplete`. */
+ status?: OpenAIResponseAllOfStatus;
+ usage?: ResponseUsage;
};
/**
* A response from the model
*/
-export type OpenAIResponse = ModelResponseProperties &
- ResponseProperties &
- OpenAIResponseAllOf;
+export type OpenAIResponse = ModelResponseProperties & ResponseProperties & OpenAIResponseAllOf;
/**
* Events that can be emitted during response streaming
*/
-export type OpenAIResponseStreamEvent =
- | ResponseCreatedEvent
- | ResponseInProgressEvent
- | ResponseCompletedEvent
- | ResponseFailedEvent
- | ResponseIncompleteEvent
- | ResponseOutputItemAddedEvent
- | ResponseOutputItemDoneEvent
- | ResponseContentPartAddedEvent
- | ResponseContentPartDoneEvent
- | ResponseErrorEvent;
+export type OpenAIResponseStreamEvent = ResponseCreatedEvent | ResponseInProgressEvent | ResponseCompletedEvent | ResponseFailedEvent | ResponseIncompleteEvent | ResponseOutputItemAddedEvent | ResponseOutputItemDoneEvent | ResponseContentPartAddedEvent | ResponseContentPartDoneEvent | ResponseErrorEvent;
+
+/**
+ * The video generation model to use
+ */
+export type OpenAIVideoCreateRequestModel = typeof OpenAIVideoCreateRequestModel[keyof typeof OpenAIVideoCreateRequestModel];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OpenAIVideoCreateRequestModel = {
+ 'sora-2': 'sora-2',
+ 'sora-2-pro': 'sora-2-pro',
+} as const;
+
+/**
+ * Clip duration in seconds
+ */
+export type OpenAIVideoCreateRequestSeconds = typeof OpenAIVideoCreateRequestSeconds[keyof typeof OpenAIVideoCreateRequestSeconds];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OpenAIVideoCreateRequestSeconds = {
+ NUMBER_4: '4',
+ NUMBER_8: '8',
+ NUMBER_12: '12',
+} as const;
+
+/**
+ * Output resolution formatted as width x height
+ */
+export type OpenAIVideoCreateRequestSize = typeof OpenAIVideoCreateRequestSize[keyof typeof OpenAIVideoCreateRequestSize];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OpenAIVideoCreateRequestSize = {
+ '720x1280': '720x1280',
+ '1280x720': '1280x720',
+ '1024x1792': '1024x1792',
+ '1792x1024': '1792x1024',
+} as const;
+
+export interface OpenAIVideoCreateRequest {
+ /** Optional image or video reference that guides generation */
+ input_reference?: Blob;
+ /** The video generation model to use */
+ model?: OpenAIVideoCreateRequestModel;
+ /** Text prompt that describes the video to generate */
+ prompt: string;
+ /** Clip duration in seconds */
+ seconds?: OpenAIVideoCreateRequestSeconds;
+ /** Output resolution formatted as width x height */
+ size?: OpenAIVideoCreateRequestSize;
+}
+
+/**
+ * Error payload that explains why generation failed, if applicable
+ */
+export type OpenAIVideoJobError = {
+ /** Error code */
+ code?: string;
+ /** Human-readable error message */
+ message?: string;
+};
+
+/**
+ * The object type, which is always video
+ */
+export type OpenAIVideoJobObject = typeof OpenAIVideoJobObject[keyof typeof OpenAIVideoJobObject];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OpenAIVideoJobObject = {
+ video: 'video',
+} as const;
+
+/**
+ * Current lifecycle status of the video job
+ */
+export type OpenAIVideoJobStatus = typeof OpenAIVideoJobStatus[keyof typeof OpenAIVideoJobStatus];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OpenAIVideoJobStatus = {
+ queued: 'queued',
+ in_progress: 'in_progress',
+ completed: 'completed',
+ failed: 'failed',
+} as const;
+
+export interface OpenAIVideoJob {
+ /** Unix timestamp (seconds) for when the job completed, if finished */
+ completed_at?: number;
+ /** Unix timestamp (seconds) for when the job was created */
+ created_at?: number;
+ /** Error payload that explains why generation failed, if applicable */
+ error?: OpenAIVideoJobError;
+ /** Unix timestamp (seconds) for when the downloadable assets expire, if set */
+ expires_at?: number;
+ /** Unique identifier for the video job */
+ id?: string;
+ /** The video generation model that produced the job */
+ model?: string;
+ /** The object type, which is always video */
+ object?: OpenAIVideoJobObject;
+ /** Approximate completion percentage for the generation task */
+ progress?: number;
+ /** Quality of the generated video */
+ quality?: string;
+ /** Identifier of the source video if this video is a remix */
+ remixed_from_video_id?: string;
+ /** Duration of the generated clip in seconds */
+ seconds?: string;
+ /** The resolution of the generated video */
+ size?: string;
+ /** Current lifecycle status of the video job */
+ status?: OpenAIVideoJobStatus;
+}
/**
* The type of output content
*/
-export type OutputAudioContentType =
- (typeof OutputAudioContentType)[keyof typeof OutputAudioContentType];
+export type OutputAudioContentType = typeof OutputAudioContentType[keyof typeof OutputAudioContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OutputAudioContentType = {
- output_audio: "output_audio",
+ output_audio: 'output_audio',
} as const;
export interface OutputAudioContent {
- /** Base64-encoded audio data */
- data: string;
- /** Transcript of the audio */
- transcript: string;
- /** The type of output content */
- type: OutputAudioContentType;
+ /** Base64-encoded audio data */
+ data: string;
+ /** Transcript of the audio */
+ transcript: string;
+ /** The type of output content */
+ type: OutputAudioContentType;
}
export type OutputContent = OutputTextContent | OutputAudioContent;
-export type OutputItem =
- | OutputMessage
- | FileSearchToolCall
- | FunctionToolCall
- | WebSearchToolCall
- | ComputerToolCall
- | ReasoningItem;
+export type OutputItem = OutputMessage | FileSearchToolCall | FunctionToolCall | WebSearchToolCall | ComputerToolCall | ReasoningItem;
/**
* The role of the message
*/
-export type OutputMessageRole =
- (typeof OutputMessageRole)[keyof typeof OutputMessageRole];
+export type OutputMessageRole = typeof OutputMessageRole[keyof typeof OutputMessageRole];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OutputMessageRole = {
- assistant: "assistant",
+ assistant: 'assistant',
} as const;
/**
* The type of output item
*/
-export type OutputMessageType =
- (typeof OutputMessageType)[keyof typeof OutputMessageType];
+export type OutputMessageType = typeof OutputMessageType[keyof typeof OutputMessageType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OutputMessageType = {
- message: "message",
+ message: 'message',
} as const;
export interface OutputMessage {
- /** The content of the message */
- content: OutputContent[];
- /** The role of the message */
- role: OutputMessageRole;
- /** The type of output item */
- type: OutputMessageType;
+ /** The content of the message */
+ content: OutputContent[];
+ /** The role of the message */
+ role: OutputMessageRole;
+ /** The type of output item */
+ type: OutputMessageType;
}
/**
* The type of output content
*/
-export type OutputTextContentType =
- (typeof OutputTextContentType)[keyof typeof OutputTextContentType];
+export type OutputTextContentType = typeof OutputTextContentType[keyof typeof OutputTextContentType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const OutputTextContentType = {
- output_text: "output_text",
+ output_text: 'output_text',
} as const;
export interface OutputTextContent {
- /** The text content */
- text: string;
- /** The type of output content */
- type: OutputTextContentType;
+ /** The text content */
+ text: string;
+ /** The type of output content */
+ type: OutputTextContentType;
}
export interface PersonalAccessToken {
- /** [Output Only]The date and time the token was created. */
- createdAt?: string;
- /** Optional. A more detailed description of the token's intended use. */
- description?: string;
- /** Unique identifier for the GitCommit */
- id?: string;
- /** Required. The name of the token. Can be a simple description. */
- name?: string;
- /** [Output Only]. The personal access token. Only returned during creation. */
- token?: string;
+ /** [Output Only]The date and time the token was created. */
+ createdAt?: string;
+ /** Optional. A more detailed description of the token's intended use. */
+ description?: string;
+ /** Unique identifier for the GitCommit */
+ id?: string;
+ /** Required. The name of the token. Can be a simple description. */
+ name?: string;
+ /** [Output Only]. The personal access token. Only returned during creation. */
+ token?: string;
}
-export type PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode =
- (typeof PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode)[keyof typeof PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode];
+export type PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode = typeof PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode[keyof typeof PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode = {
- creative: "creative",
- precise: "precise",
+ creative: 'creative',
+ precise: 'precise',
} as const;
export interface PikaBodyGenerate22C2vGenerate22PikascenesPost {
- /** Aspect ratio (width / height) */
- aspectRatio?: number;
- duration?: number;
- images?: Blob[];
- ingredientsMode: PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode;
- negativePrompt?: string;
- promptText?: string;
- resolution?: string;
- seed?: number;
+ /** Aspect ratio (width / height) */
+ aspectRatio?: number;
+ duration?: number;
+ images?: Blob[];
+ ingredientsMode: PikaBodyGenerate22C2vGenerate22PikascenesPostIngredientsMode;
+ negativePrompt?: string;
+ promptText?: string;
+ resolution?: string;
+ seed?: number;
}
export interface PikaBodyGenerate22I2vGenerate22I2vPost {
- duration?: PikaDurationEnum;
- /** @nullable */
- image?: Blob | null;
- /** @nullable */
- negativePrompt?: string | null;
- /** @nullable */
- promptText?: string | null;
- resolution?: PikaResolutionEnum;
- /** @nullable */
- seed?: number | null;
+ duration?: PikaDurationEnum;
+ /** @nullable */
+ image?: Blob | null;
+ /** @nullable */
+ negativePrompt?: string | null;
+ /** @nullable */
+ promptText?: string | null;
+ resolution?: PikaResolutionEnum;
+ /** @nullable */
+ seed?: number | null;
}
export interface PikaBodyGenerate22KeyframeGenerate22PikaframesPost {
- /**
- * @minimum 5
- * @maximum 10
- */
- duration?: number;
- /** Array of keyframe images */
- keyFrames?: Blob[];
- negativePrompt?: string;
- promptText: string;
- resolution?: PikaResolutionEnum;
- seed?: number;
+ /**
+ * @minimum 5
+ * @maximum 10
+ */
+ duration?: number;
+ /** Array of keyframe images */
+ keyFrames?: Blob[];
+ negativePrompt?: string;
+ promptText: string;
+ resolution?: PikaResolutionEnum;
+ seed?: number;
}
export interface PikaBodyGenerate22T2vGenerate22T2vPost {
- /**
- * Aspect ratio (width / height)
- * @minimum 0.4
- * @maximum 2.5
- */
- aspectRatio?: number;
- duration?: PikaDurationEnum;
- /** @nullable */
- negativePrompt?: string | null;
- promptText: string;
- resolution?: PikaResolutionEnum;
- /** @nullable */
- seed?: number | null;
+ /**
+ * Aspect ratio (width / height)
+ * @minimum 0.4
+ * @maximum 2.5
+ */
+ aspectRatio?: number;
+ duration?: PikaDurationEnum;
+ /** @nullable */
+ negativePrompt?: string | null;
+ promptText: string;
+ resolution?: PikaResolutionEnum;
+ /** @nullable */
+ seed?: number | null;
}
export interface PikaBodyGeneratePikadditionsGeneratePikadditionsPost {
- image?: Blob;
- negativePrompt?: string;
- promptText?: string;
- seed?: number;
- video?: Blob;
+ image?: Blob;
+ negativePrompt?: string;
+ promptText?: string;
+ seed?: number;
+ video?: Blob;
}
export interface PikaBodyGeneratePikaffectsGeneratePikaffectsPost {
- image?: Blob;
- negativePrompt?: string;
- pikaffect?: Pikaffect;
- promptText?: string;
- seed?: number;
+ image?: Blob;
+ negativePrompt?: string;
+ pikaffect?: Pikaffect;
+ promptText?: string;
+ seed?: number;
}
export interface PikaBodyGeneratePikaswapsGeneratePikaswapsPost {
- image?: Blob;
- /** A mask image that specifies the region to modify, where the mask is white and the background is black */
- modifyRegionMask?: Blob;
- /** Plaintext description of the object / region to modify */
- modifyRegionRoi?: string;
- negativePrompt?: string;
- promptText?: string;
- seed?: number;
- video?: Blob;
+ image?: Blob;
+ /** A mask image that specifies the region to modify, where the mask is white and the background is black */
+ modifyRegionMask?: Blob;
+ /** Plaintext description of the object / region to modify */
+ modifyRegionRoi?: string;
+ negativePrompt?: string;
+ promptText?: string;
+ seed?: number;
+ video?: Blob;
}
-export type PikaDurationEnum =
- (typeof PikaDurationEnum)[keyof typeof PikaDurationEnum];
+export type PikaDurationEnum = typeof PikaDurationEnum[keyof typeof PikaDurationEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PikaDurationEnum = {
- NUMBER_5: 5,
- NUMBER_10: 10,
+ NUMBER_5: 5,
+ NUMBER_10: 10,
} as const;
export interface PikaGenerateResponse {
- video_id: string;
+ video_id: string;
}
export interface PikaHTTPValidationError {
- detail?: PikaValidationError[];
+ detail?: PikaValidationError[];
}
-export type PikaResolutionEnum =
- (typeof PikaResolutionEnum)[keyof typeof PikaResolutionEnum];
+export type PikaResolutionEnum = typeof PikaResolutionEnum[keyof typeof PikaResolutionEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PikaResolutionEnum = {
- "1080p": "1080p",
- "720p": "720p",
+ '1080p': '1080p',
+ '720p': '720p',
} as const;
-export type PikaStatusEnum =
- (typeof PikaStatusEnum)[keyof typeof PikaStatusEnum];
+export type PikaStatusEnum = typeof PikaStatusEnum[keyof typeof PikaStatusEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PikaStatusEnum = {
- queued: "queued",
- started: "started",
- finished: "finished",
+ queued: 'queued',
+ started: 'started',
+ finished: 'finished',
} as const;
export type PikaValidationErrorLocItem = string | number;
export interface PikaValidationError {
- loc: PikaValidationErrorLocItem[];
- msg: string;
- type: string;
+ loc: PikaValidationErrorLocItem[];
+ msg: string;
+ type: string;
}
export interface PikaVideoResponse {
- id: string;
- /** @nullable */
- progress?: number | null;
- status: PikaStatusEnum;
- /** @nullable */
- url?: string | null;
+ id: string;
+ /** @nullable */
+ progress?: number | null;
+ status: PikaStatusEnum;
+ /** @nullable */
+ url?: string | null;
}
-export type Pikaffect = (typeof Pikaffect)[keyof typeof Pikaffect];
+export type Pikaffect = typeof Pikaffect[keyof typeof Pikaffect];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Pikaffect = {
- "Cake-ify": "Cake-ify",
- Crumble: "Crumble",
- Crush: "Crush",
- Decapitate: "Decapitate",
- Deflate: "Deflate",
- Dissolve: "Dissolve",
- Explode: "Explode",
- "Eye-pop": "Eye-pop",
- Inflate: "Inflate",
- Levitate: "Levitate",
- Melt: "Melt",
- Peel: "Peel",
- Poke: "Poke",
- Squish: "Squish",
- "Ta-da": "Ta-da",
- Tear: "Tear",
+ 'Cake-ify': 'Cake-ify',
+ Crumble: 'Crumble',
+ Crush: 'Crush',
+ Decapitate: 'Decapitate',
+ Deflate: 'Deflate',
+ Dissolve: 'Dissolve',
+ Explode: 'Explode',
+ 'Eye-pop': 'Eye-pop',
+ Inflate: 'Inflate',
+ Levitate: 'Levitate',
+ Melt: 'Melt',
+ Peel: 'Peel',
+ Poke: 'Poke',
+ Squish: 'Squish',
+ 'Ta-da': 'Ta-da',
+ Tear: 'Tear',
} as const;
export type PixverseImageUploadResponseResp = {
- img_id?: number;
+ img_id?: number;
};
export interface PixverseImageUploadResponse {
- ErrCode?: number;
- ErrMsg?: string;
- Resp?: PixverseImageUploadResponseResp;
+ ErrCode?: number;
+ ErrMsg?: string;
+ Resp?: PixverseImageUploadResponseResp;
}
-export type PixverseImageVideoRequestDuration =
- (typeof PixverseImageVideoRequestDuration)[keyof typeof PixverseImageVideoRequestDuration];
+export type PixverseImageVideoRequestDuration = typeof PixverseImageVideoRequestDuration[keyof typeof PixverseImageVideoRequestDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseImageVideoRequestDuration = {
- NUMBER_5: 5,
- NUMBER_8: 8,
+ NUMBER_5: 5,
+ NUMBER_8: 8,
} as const;
-export type PixverseImageVideoRequestModel =
- (typeof PixverseImageVideoRequestModel)[keyof typeof PixverseImageVideoRequestModel];
+export type PixverseImageVideoRequestModel = typeof PixverseImageVideoRequestModel[keyof typeof PixverseImageVideoRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseImageVideoRequestModel = {
- v35: "v3.5",
+ v35: 'v3.5',
} as const;
-export type PixverseImageVideoRequestMotionMode =
- (typeof PixverseImageVideoRequestMotionMode)[keyof typeof PixverseImageVideoRequestMotionMode];
+export type PixverseImageVideoRequestMotionMode = typeof PixverseImageVideoRequestMotionMode[keyof typeof PixverseImageVideoRequestMotionMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseImageVideoRequestMotionMode = {
- normal: "normal",
- fast: "fast",
+ normal: 'normal',
+ fast: 'fast',
} as const;
-export type PixverseImageVideoRequestQuality =
- (typeof PixverseImageVideoRequestQuality)[keyof typeof PixverseImageVideoRequestQuality];
+export type PixverseImageVideoRequestQuality = typeof PixverseImageVideoRequestQuality[keyof typeof PixverseImageVideoRequestQuality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseImageVideoRequestQuality = {
- "360p": "360p",
- "540p": "540p",
- "720p": "720p",
- "1080p": "1080p",
+ '360p': '360p',
+ '540p': '540p',
+ '720p': '720p',
+ '1080p': '1080p',
} as const;
-export type PixverseImageVideoRequestStyle =
- (typeof PixverseImageVideoRequestStyle)[keyof typeof PixverseImageVideoRequestStyle];
+export type PixverseImageVideoRequestStyle = typeof PixverseImageVideoRequestStyle[keyof typeof PixverseImageVideoRequestStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseImageVideoRequestStyle = {
- anime: "anime",
- "3d_animation": "3d_animation",
- clay: "clay",
- comic: "comic",
- cyberpunk: "cyberpunk",
+ anime: 'anime',
+ '3d_animation': '3d_animation',
+ clay: 'clay',
+ comic: 'comic',
+ cyberpunk: 'cyberpunk',
} as const;
export interface PixverseImageVideoRequest {
- duration: PixverseImageVideoRequestDuration;
- img_id: number;
- model: PixverseImageVideoRequestModel;
- motion_mode?: PixverseImageVideoRequestMotionMode;
- prompt: string;
- quality: PixverseImageVideoRequestQuality;
- seed?: number;
- style?: PixverseImageVideoRequestStyle;
- template_id?: number;
- water_mark?: boolean;
+ duration: PixverseImageVideoRequestDuration;
+ img_id: number;
+ model: PixverseImageVideoRequestModel;
+ motion_mode?: PixverseImageVideoRequestMotionMode;
+ prompt: string;
+ quality: PixverseImageVideoRequestQuality;
+ seed?: number;
+ style?: PixverseImageVideoRequestStyle;
+ template_id?: number;
+ water_mark?: boolean;
}
-export type PixverseTextVideoRequestAspectRatio =
- (typeof PixverseTextVideoRequestAspectRatio)[keyof typeof PixverseTextVideoRequestAspectRatio];
+export type PixverseTextVideoRequestAspectRatio = typeof PixverseTextVideoRequestAspectRatio[keyof typeof PixverseTextVideoRequestAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestAspectRatio = {
- "16:9": "16:9",
- "4:3": "4:3",
- "1:1": "1:1",
- "3:4": "3:4",
- "9:16": "9:16",
+ '16:9': '16:9',
+ '4:3': '4:3',
+ '1:1': '1:1',
+ '3:4': '3:4',
+ '9:16': '9:16',
} as const;
-export type PixverseTextVideoRequestDuration =
- (typeof PixverseTextVideoRequestDuration)[keyof typeof PixverseTextVideoRequestDuration];
+export type PixverseTextVideoRequestDuration = typeof PixverseTextVideoRequestDuration[keyof typeof PixverseTextVideoRequestDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestDuration = {
- NUMBER_5: 5,
- NUMBER_8: 8,
+ NUMBER_5: 5,
+ NUMBER_8: 8,
} as const;
-export type PixverseTextVideoRequestModel =
- (typeof PixverseTextVideoRequestModel)[keyof typeof PixverseTextVideoRequestModel];
+export type PixverseTextVideoRequestModel = typeof PixverseTextVideoRequestModel[keyof typeof PixverseTextVideoRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestModel = {
- v35: "v3.5",
+ v35: 'v3.5',
} as const;
-export type PixverseTextVideoRequestMotionMode =
- (typeof PixverseTextVideoRequestMotionMode)[keyof typeof PixverseTextVideoRequestMotionMode];
+export type PixverseTextVideoRequestMotionMode = typeof PixverseTextVideoRequestMotionMode[keyof typeof PixverseTextVideoRequestMotionMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestMotionMode = {
- normal: "normal",
- fast: "fast",
+ normal: 'normal',
+ fast: 'fast',
} as const;
-export type PixverseTextVideoRequestQuality =
- (typeof PixverseTextVideoRequestQuality)[keyof typeof PixverseTextVideoRequestQuality];
+export type PixverseTextVideoRequestQuality = typeof PixverseTextVideoRequestQuality[keyof typeof PixverseTextVideoRequestQuality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestQuality = {
- "360p": "360p",
- "540p": "540p",
- "720p": "720p",
- "1080p": "1080p",
+ '360p': '360p',
+ '540p': '540p',
+ '720p': '720p',
+ '1080p': '1080p',
} as const;
-export type PixverseTextVideoRequestStyle =
- (typeof PixverseTextVideoRequestStyle)[keyof typeof PixverseTextVideoRequestStyle];
+export type PixverseTextVideoRequestStyle = typeof PixverseTextVideoRequestStyle[keyof typeof PixverseTextVideoRequestStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTextVideoRequestStyle = {
- anime: "anime",
- "3d_animation": "3d_animation",
- clay: "clay",
- comic: "comic",
- cyberpunk: "cyberpunk",
+ anime: 'anime',
+ '3d_animation': '3d_animation',
+ clay: 'clay',
+ comic: 'comic',
+ cyberpunk: 'cyberpunk',
} as const;
export interface PixverseTextVideoRequest {
- aspect_ratio: PixverseTextVideoRequestAspectRatio;
- duration: PixverseTextVideoRequestDuration;
- model: PixverseTextVideoRequestModel;
- motion_mode?: PixverseTextVideoRequestMotionMode;
- negative_prompt?: string;
- prompt: string;
- quality: PixverseTextVideoRequestQuality;
- seed?: number;
- style?: PixverseTextVideoRequestStyle;
- template_id?: number;
- water_mark?: boolean;
+ aspect_ratio: PixverseTextVideoRequestAspectRatio;
+ duration: PixverseTextVideoRequestDuration;
+ model: PixverseTextVideoRequestModel;
+ motion_mode?: PixverseTextVideoRequestMotionMode;
+ negative_prompt?: string;
+ prompt: string;
+ quality: PixverseTextVideoRequestQuality;
+ seed?: number;
+ style?: PixverseTextVideoRequestStyle;
+ template_id?: number;
+ water_mark?: boolean;
}
-export type PixverseTransitionVideoRequestDuration =
- (typeof PixverseTransitionVideoRequestDuration)[keyof typeof PixverseTransitionVideoRequestDuration];
+export type PixverseTransitionVideoRequestDuration = typeof PixverseTransitionVideoRequestDuration[keyof typeof PixverseTransitionVideoRequestDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTransitionVideoRequestDuration = {
- NUMBER_5: 5,
- NUMBER_8: 8,
+ NUMBER_5: 5,
+ NUMBER_8: 8,
} as const;
-export type PixverseTransitionVideoRequestModel =
- (typeof PixverseTransitionVideoRequestModel)[keyof typeof PixverseTransitionVideoRequestModel];
+export type PixverseTransitionVideoRequestModel = typeof PixverseTransitionVideoRequestModel[keyof typeof PixverseTransitionVideoRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTransitionVideoRequestModel = {
- v35: "v3.5",
+ v35: 'v3.5',
} as const;
-export type PixverseTransitionVideoRequestMotionMode =
- (typeof PixverseTransitionVideoRequestMotionMode)[keyof typeof PixverseTransitionVideoRequestMotionMode];
+export type PixverseTransitionVideoRequestMotionMode = typeof PixverseTransitionVideoRequestMotionMode[keyof typeof PixverseTransitionVideoRequestMotionMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTransitionVideoRequestMotionMode = {
- normal: "normal",
- fast: "fast",
+ normal: 'normal',
+ fast: 'fast',
} as const;
-export type PixverseTransitionVideoRequestQuality =
- (typeof PixverseTransitionVideoRequestQuality)[keyof typeof PixverseTransitionVideoRequestQuality];
+export type PixverseTransitionVideoRequestQuality = typeof PixverseTransitionVideoRequestQuality[keyof typeof PixverseTransitionVideoRequestQuality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTransitionVideoRequestQuality = {
- "360p": "360p",
- "540p": "540p",
- "720p": "720p",
- "1080p": "1080p",
+ '360p': '360p',
+ '540p': '540p',
+ '720p': '720p',
+ '1080p': '1080p',
} as const;
-export type PixverseTransitionVideoRequestStyle =
- (typeof PixverseTransitionVideoRequestStyle)[keyof typeof PixverseTransitionVideoRequestStyle];
+export type PixverseTransitionVideoRequestStyle = typeof PixverseTransitionVideoRequestStyle[keyof typeof PixverseTransitionVideoRequestStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseTransitionVideoRequestStyle = {
- anime: "anime",
- "3d_animation": "3d_animation",
- clay: "clay",
- comic: "comic",
- cyberpunk: "cyberpunk",
+ anime: 'anime',
+ '3d_animation': '3d_animation',
+ clay: 'clay',
+ comic: 'comic',
+ cyberpunk: 'cyberpunk',
} as const;
export interface PixverseTransitionVideoRequest {
- duration: PixverseTransitionVideoRequestDuration;
- first_frame_img: number;
- last_frame_img: number;
- model: PixverseTransitionVideoRequestModel;
- motion_mode: PixverseTransitionVideoRequestMotionMode;
- prompt: string;
- quality: PixverseTransitionVideoRequestQuality;
- seed: number;
- style?: PixverseTransitionVideoRequestStyle;
- template_id?: number;
- water_mark?: boolean;
+ duration: PixverseTransitionVideoRequestDuration;
+ first_frame_img: number;
+ last_frame_img: number;
+ model: PixverseTransitionVideoRequestModel;
+ motion_mode: PixverseTransitionVideoRequestMotionMode;
+ prompt: string;
+ quality: PixverseTransitionVideoRequestQuality;
+ seed: number;
+ style?: PixverseTransitionVideoRequestStyle;
+ template_id?: number;
+ water_mark?: boolean;
}
export type PixverseVideoResponseResp = {
- video_id?: number;
+ video_id?: number;
};
export interface PixverseVideoResponse {
- ErrCode?: number;
- ErrMsg?: string;
- Resp?: PixverseVideoResponseResp;
+ ErrCode?: number;
+ ErrMsg?: string;
+ Resp?: PixverseVideoResponseResp;
}
/**
@@ -4848,99 +4955,99 @@ export interface PixverseVideoResponse {
* 8 - Generation failed
*/
-export type PixverseVideoResultResponseRespStatus =
- (typeof PixverseVideoResultResponseRespStatus)[keyof typeof PixverseVideoResultResponseRespStatus];
+export type PixverseVideoResultResponseRespStatus = typeof PixverseVideoResultResponseRespStatus[keyof typeof PixverseVideoResultResponseRespStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PixverseVideoResultResponseRespStatus = {
- NUMBER_1: 1,
- NUMBER_5: 5,
- NUMBER_6: 6,
- NUMBER_7: 7,
- NUMBER_8: 8,
+ NUMBER_1: 1,
+ NUMBER_5: 5,
+ NUMBER_6: 6,
+ NUMBER_7: 7,
+ NUMBER_8: 8,
} as const;
export type PixverseVideoResultResponseResp = {
- create_time?: string;
- id?: number;
- modify_time?: string;
- negative_prompt?: string;
- outputHeight?: number;
- outputWidth?: number;
- prompt?: string;
- resolution_ratio?: number;
- seed?: number;
- size?: number;
- /** Video generation status codes:
- * 1 - Generation successful
- * 5 - Generating
- * 6 - Deleted
- * 7 - Contents moderation failed
- * 8 - Generation failed
- */
- status?: PixverseVideoResultResponseRespStatus;
- style?: string;
- url?: string;
+ create_time?: string;
+ id?: number;
+ modify_time?: string;
+ negative_prompt?: string;
+ outputHeight?: number;
+ outputWidth?: number;
+ prompt?: string;
+ resolution_ratio?: number;
+ seed?: number;
+ size?: number;
+ /** Video generation status codes:
+* 1 - Generation successful
+* 5 - Generating
+* 6 - Deleted
+* 7 - Contents moderation failed
+* 8 - Generation failed
+ */
+ status?: PixverseVideoResultResponseRespStatus;
+ style?: string;
+ url?: string;
};
export interface PixverseVideoResultResponse {
- ErrCode?: number;
- ErrMsg?: string;
- Resp?: PixverseVideoResultResponseResp;
+ ErrCode?: number;
+ ErrMsg?: string;
+ Resp?: PixverseVideoResultResponseResp;
}
export interface Publisher {
- /** The date and time the publisher was created. */
- createdAt?: string;
- description?: string;
- /** The unique identifier for the publisher. It's akin to a username. Should be lowercase. */
- id?: string;
- /** URL to the publisher's logo. */
- logo?: string;
- /** A list of members in the publisher. */
- members?: PublisherMember[];
- name?: string;
- source_code_repo?: string;
- status?: PublisherStatus;
- support?: string;
- website?: string;
+ /** The date and time the publisher was created. */
+ createdAt?: string;
+ description?: string;
+ /** The unique identifier for the publisher. It's akin to a username. Should be lowercase. */
+ id?: string;
+ /** URL to the publisher's logo. */
+ logo?: string;
+ /** A list of members in the publisher. */
+ members?: PublisherMember[];
+ name?: string;
+ source_code_repo?: string;
+ status?: PublisherStatus;
+ support?: string;
+ website?: string;
}
export interface PublisherMember {
- /** The unique identifier for the publisher member. */
- id?: string;
- /** The role of the user in the publisher. */
- role?: string;
- user?: PublisherUser;
+ /** The unique identifier for the publisher member. */
+ id?: string;
+ /** The role of the user in the publisher. */
+ role?: string;
+ user?: PublisherUser;
}
-export type PublisherStatus =
- (typeof PublisherStatus)[keyof typeof PublisherStatus];
+export type PublisherStatus = typeof PublisherStatus[keyof typeof PublisherStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PublisherStatus = {
- PublisherStatusActive: "PublisherStatusActive",
- PublisherStatusBanned: "PublisherStatusBanned",
+ PublisherStatusActive: 'PublisherStatusActive',
+ PublisherStatusBanned: 'PublisherStatusBanned',
} as const;
export interface PublisherUser {
- /** The email address for this user. */
- email?: string;
- /** The unique id for this user. */
- id?: string;
- /** The name for this user. */
- name?: string;
+ /** The email address for this user. */
+ email?: string;
+ /** The unique id for this user. */
+ id?: string;
+ /** The name for this user. */
+ name?: string;
}
/**
* RGB color values
*/
export interface RGBColor {
- /**
- * @minItems 3
- * @maxItems 3
- */
- rgb: number[];
+ /**
+ * @minItems 3
+ * @maxItems 3
+ */
+ rgb: number[];
}
/**
@@ -4952,14 +5059,14 @@ One of `auto`, `concise`, or `detailed`.
* @deprecated
*/
-export type ReasoningGenerateSummary =
- (typeof ReasoningGenerateSummary)[keyof typeof ReasoningGenerateSummary];
+export type ReasoningGenerateSummary = typeof ReasoningGenerateSummary[keyof typeof ReasoningGenerateSummary];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningGenerateSummary = {
- auto: "auto",
- concise: "concise",
- detailed: "detailed",
+ auto: 'auto',
+ concise: 'concise',
+ detailed: 'detailed',
} as const;
/**
@@ -4968,14 +5075,14 @@ useful for debugging and understanding the model's reasoning process.
One of `auto`, `concise`, or `detailed`.
*/
-export type ReasoningSummary =
- (typeof ReasoningSummary)[keyof typeof ReasoningSummary];
+export type ReasoningSummary = typeof ReasoningSummary[keyof typeof ReasoningSummary];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningSummary = {
- auto: "auto",
- concise: "concise",
- detailed: "detailed",
+ auto: 'auto',
+ concise: 'concise',
+ detailed: 'detailed',
} as const;
/**
@@ -4986,8 +5093,8 @@ Configuration options for
*/
export interface Reasoning {
- effort?: ReasoningEffort;
- /**
+ effort?: ReasoningEffort;
+ /**
* **Deprecated:** use `summary` instead.
A summary of the reasoning performed by the model. This can be
@@ -4996,12 +5103,12 @@ One of `auto`, `concise`, or `detailed`.
* @deprecated
*/
- generate_summary?: ReasoningGenerateSummary;
- /** A summary of the reasoning performed by the model. This can be
+ generate_summary?: ReasoningGenerateSummary;
+ /** A summary of the reasoning performed by the model. This can be
useful for debugging and understanding the model's reasoning process.
One of `auto`, `concise`, or `detailed`.
*/
- summary?: ReasoningSummary;
+ summary?: ReasoningSummary;
}
/**
@@ -5014,14 +5121,14 @@ reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
*/
-export type ReasoningEffort =
- (typeof ReasoningEffort)[keyof typeof ReasoningEffort];
+export type ReasoningEffort = typeof ReasoningEffort[keyof typeof ReasoningEffort];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningEffort = {
- low: "low",
- medium: "medium",
- high: "high",
+ low: 'low',
+ medium: 'medium',
+ high: 'high',
} as const;
/**
@@ -5029,48 +5136,48 @@ export const ReasoningEffort = {
`incomplete`. Populated when items are returned via API.
*/
-export type ReasoningItemStatus =
- (typeof ReasoningItemStatus)[keyof typeof ReasoningItemStatus];
+export type ReasoningItemStatus = typeof ReasoningItemStatus[keyof typeof ReasoningItemStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningItemStatus = {
- in_progress: "in_progress",
- completed: "completed",
- incomplete: "incomplete",
+ in_progress: 'in_progress',
+ completed: 'completed',
+ incomplete: 'incomplete',
} as const;
/**
* The type of the object. Always `summary_text`.
*/
-export type ReasoningItemSummaryItemType =
- (typeof ReasoningItemSummaryItemType)[keyof typeof ReasoningItemSummaryItemType];
+export type ReasoningItemSummaryItemType = typeof ReasoningItemSummaryItemType[keyof typeof ReasoningItemSummaryItemType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningItemSummaryItemType = {
- summary_text: "summary_text",
+ summary_text: 'summary_text',
} as const;
export type ReasoningItemSummaryItem = {
- /** A short summary of the reasoning used by the model when generating
+ /** A short summary of the reasoning used by the model when generating
the response.
*/
- text: string;
- /** The type of the object. Always `summary_text`.
- */
- type: ReasoningItemSummaryItemType;
+ text: string;
+ /** The type of the object. Always `summary_text`.
+ */
+ type: ReasoningItemSummaryItemType;
};
/**
* The type of the object. Always `reasoning`.
*/
-export type ReasoningItemType =
- (typeof ReasoningItemType)[keyof typeof ReasoningItemType];
+export type ReasoningItemType = typeof ReasoningItemType[keyof typeof ReasoningItemType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReasoningItemType = {
- reasoning: "reasoning",
+ reasoning: 'reasoning',
} as const;
/**
@@ -5079,487 +5186,487 @@ a response.
*/
export interface ReasoningItem {
- /** The unique identifier of the reasoning content.
- */
- id: string;
- /** The status of the item. One of `in_progress`, `completed`, or
+ /** The unique identifier of the reasoning content.
+ */
+ id: string;
+ /** The status of the item. One of `in_progress`, `completed`, or
`incomplete`. Populated when items are returned via API.
*/
- status?: ReasoningItemStatus;
- /** Reasoning text contents.
- */
- summary: ReasoningItemSummaryItem[];
- /** The type of the object. Always `reasoning`.
- */
- type: ReasoningItemType;
+ status?: ReasoningItemStatus;
+ /** Reasoning text contents.
+ */
+ summary: ReasoningItemSummaryItem[];
+ /** The type of the object. Always `reasoning`.
+ */
+ type: ReasoningItemType;
}
export interface RecraftGenerateImageResponse {
- created: number;
- credits: number;
- data: RecraftImage[];
+ created: number;
+ credits: number;
+ data: RecraftImage[];
}
export interface RecraftImage {
- b64_json?: string;
- features?: RecraftImageFeatures;
- image_id: string;
- revised_prompt?: string;
- url?: string;
+ b64_json?: string;
+ features?: RecraftImageFeatures;
+ image_id: string;
+ revised_prompt?: string;
+ url?: string;
}
export interface RecraftImageColor {
- rgb?: number[];
- std?: number[];
- weight?: number;
+ rgb?: number[];
+ std?: number[];
+ weight?: number;
}
export interface RecraftImageFeatures {
- nsfw_score?: number;
+ nsfw_score?: number;
}
-export type RecraftImageFormat =
- (typeof RecraftImageFormat)[keyof typeof RecraftImageFormat];
+export type RecraftImageFormat = typeof RecraftImageFormat[keyof typeof RecraftImageFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RecraftImageFormat = {
- webp: "webp",
- png: "png",
+ webp: 'webp',
+ png: 'png',
} as const;
/**
* The controls for the generated image
*/
export type RecraftImageGenerationRequestControls = {
- /**
- * Defines artistic tone of your image. At a simple level, the person looks straight at the camera in a static and clean style. Dynamic and eccentric levels introduce movement and creativity.
- * @minimum 0
- * @maximum 5
- * @nullable
- */
- artistic_level?: number | null;
- background_color?: RGBColor;
- /** An array of preferable colors */
- colors?: RGBColor[];
- /** Do not embed text layouts */
- no_text?: boolean;
+ /**
+ * Defines artistic tone of your image. At a simple level, the person looks straight at the camera in a static and clean style. Dynamic and eccentric levels introduce movement and creativity.
+ * @minimum 0
+ * @maximum 5
+ * @nullable
+ */
+ artistic_level?: number | null;
+ background_color?: RGBColor;
+ /** An array of preferable colors */
+ colors?: RGBColor[];
+ /** Do not embed text layouts */
+ no_text?: boolean;
};
/**
* Parameters for the Recraft image generation proxy request.
*/
export interface RecraftImageGenerationRequest {
- /** The controls for the generated image */
- controls?: RecraftImageGenerationRequestControls;
- /** The model to use for generation (e.g., "recraftv3") */
- model: string;
- /**
- * The number of images to generate
- * @minimum 1
- * @maximum 4
- */
- n: number;
- /** The text prompt describing the image to generate */
- prompt: string;
- /** The size of the generated image (e.g., "1024x1024") */
- size: string;
- /** The style to apply to the generated image (e.g., "digital_illustration") */
- style?: string;
- /** The style ID to apply to the generated image (e.g., "123e4567-e89b-12d3-a456-426614174000"). If style_id is provided, style should not be provided. */
- style_id?: string;
+ /** The controls for the generated image */
+ controls?: RecraftImageGenerationRequestControls;
+ /** The model to use for generation (e.g., "recraftv3") */
+ model: string;
+ /**
+ * The number of images to generate
+ * @minimum 1
+ * @maximum 4
+ */
+ n: number;
+ /** The text prompt describing the image to generate */
+ prompt: string;
+ /** The size of the generated image (e.g., "1024x1024") */
+ size: string;
+ /** The style to apply to the generated image (e.g., "digital_illustration") */
+ style?: string;
+ /** The style ID to apply to the generated image (e.g., "123e4567-e89b-12d3-a456-426614174000"). If style_id is provided, style should not be provided. */
+ style_id?: string;
}
export type RecraftImageGenerationResponseDataItem = {
- /** Unique identifier for the generated image */
- image_id?: string;
- /** URL to access the generated image */
- url?: string;
+ /** Unique identifier for the generated image */
+ image_id?: string;
+ /** URL to access the generated image */
+ url?: string;
};
/**
* Response from the Recraft image generation API.
*/
export interface RecraftImageGenerationResponse {
- /** Unix timestamp when the generation was created */
- created: number;
- /** Number of credits used for the generation */
- credits: number;
- /** Array of generated image information */
- data: RecraftImageGenerationResponseDataItem[];
+ /** Unix timestamp when the generation was created */
+ created: number;
+ /** Number of credits used for the generation */
+ credits: number;
+ /** Array of generated image information */
+ data: RecraftImageGenerationResponseDataItem[];
}
-export type RecraftImageStyle =
- (typeof RecraftImageStyle)[keyof typeof RecraftImageStyle];
+export type RecraftImageStyle = typeof RecraftImageStyle[keyof typeof RecraftImageStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RecraftImageStyle = {
- digital_illustration: "digital_illustration",
- icon: "icon",
- realistic_image: "realistic_image",
- vector_illustration: "vector_illustration",
+ digital_illustration: 'digital_illustration',
+ icon: 'icon',
+ realistic_image: 'realistic_image',
+ vector_illustration: 'vector_illustration',
} as const;
-export type RecraftImageSubStyle =
- (typeof RecraftImageSubStyle)[keyof typeof RecraftImageSubStyle];
+export type RecraftImageSubStyle = typeof RecraftImageSubStyle[keyof typeof RecraftImageSubStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RecraftImageSubStyle = {
- "2d_art_poster": "2d_art_poster",
- "3d": "3d",
- "80s": "80s",
- glow: "glow",
- grain: "grain",
- hand_drawn: "hand_drawn",
- infantile_sketch: "infantile_sketch",
- kawaii: "kawaii",
- pixel_art: "pixel_art",
- psychedelic: "psychedelic",
- seamless: "seamless",
- voxel: "voxel",
- watercolor: "watercolor",
- broken_line: "broken_line",
- colored_outline: "colored_outline",
- colored_shapes: "colored_shapes",
- colored_shapes_gradient: "colored_shapes_gradient",
- doodle_fill: "doodle_fill",
- doodle_offset_fill: "doodle_offset_fill",
- offset_fill: "offset_fill",
- outline: "outline",
- outline_gradient: "outline_gradient",
- uneven_fill: "uneven_fill",
- "70s": "70s",
- cartoon: "cartoon",
- doodle_line_art: "doodle_line_art",
- engraving: "engraving",
- flat_2: "flat_2",
- line_art: "line_art",
- linocut: "linocut",
- b_and_w: "b_and_w",
- enterprise: "enterprise",
- hard_flash: "hard_flash",
- hdr: "hdr",
- motion_blur: "motion_blur",
- natural_light: "natural_light",
- studio_portrait: "studio_portrait",
- line_circuit: "line_circuit",
- "2d_art_poster_2": "2d_art_poster_2",
- engraving_color: "engraving_color",
- flat_air_art: "flat_air_art",
- hand_drawn_outline: "hand_drawn_outline",
- handmade_3d: "handmade_3d",
- stickers_drawings: "stickers_drawings",
- plastic: "plastic",
- pictogram: "pictogram",
+ '2d_art_poster': '2d_art_poster',
+ '3d': '3d',
+ '80s': '80s',
+ glow: 'glow',
+ grain: 'grain',
+ hand_drawn: 'hand_drawn',
+ infantile_sketch: 'infantile_sketch',
+ kawaii: 'kawaii',
+ pixel_art: 'pixel_art',
+ psychedelic: 'psychedelic',
+ seamless: 'seamless',
+ voxel: 'voxel',
+ watercolor: 'watercolor',
+ broken_line: 'broken_line',
+ colored_outline: 'colored_outline',
+ colored_shapes: 'colored_shapes',
+ colored_shapes_gradient: 'colored_shapes_gradient',
+ doodle_fill: 'doodle_fill',
+ doodle_offset_fill: 'doodle_offset_fill',
+ offset_fill: 'offset_fill',
+ outline: 'outline',
+ outline_gradient: 'outline_gradient',
+ uneven_fill: 'uneven_fill',
+ '70s': '70s',
+ cartoon: 'cartoon',
+ doodle_line_art: 'doodle_line_art',
+ engraving: 'engraving',
+ flat_2: 'flat_2',
+ line_art: 'line_art',
+ linocut: 'linocut',
+ b_and_w: 'b_and_w',
+ enterprise: 'enterprise',
+ hard_flash: 'hard_flash',
+ hdr: 'hdr',
+ motion_blur: 'motion_blur',
+ natural_light: 'natural_light',
+ studio_portrait: 'studio_portrait',
+ line_circuit: 'line_circuit',
+ '2d_art_poster_2': '2d_art_poster_2',
+ engraving_color: 'engraving_color',
+ flat_air_art: 'flat_air_art',
+ hand_drawn_outline: 'hand_drawn_outline',
+ handmade_3d: 'handmade_3d',
+ stickers_drawings: 'stickers_drawings',
+ plastic: 'plastic',
+ pictogram: 'pictogram',
} as const;
export interface RecraftImageToImageRequest {
- block_nsfw?: boolean;
- calculate_features?: boolean;
- controls?: RecraftUserControls;
- image: Blob;
- image_format?: RecraftImageFormat;
- model?: RecraftTransformModel;
- n?: number;
- negative_prompt?: string;
- prompt: string;
- response_format?: RecraftResponseFormat;
- strength: number;
- style?: RecraftImageStyle;
- style_id?: string;
- substyle?: RecraftImageSubStyle;
- text_layout?: RecraftTextLayout;
+ block_nsfw?: boolean;
+ calculate_features?: boolean;
+ controls?: RecraftUserControls;
+ image: Blob;
+ image_format?: RecraftImageFormat;
+ model?: RecraftTransformModel;
+ n?: number;
+ negative_prompt?: string;
+ prompt: string;
+ response_format?: RecraftResponseFormat;
+ strength: number;
+ style?: RecraftImageStyle;
+ style_id?: string;
+ substyle?: RecraftImageSubStyle;
+ text_layout?: RecraftTextLayout;
}
export interface RecraftProcessImageRequest {
- image: Blob;
- image_format?: RecraftImageFormat;
- response_format?: RecraftResponseFormat;
+ image: Blob;
+ image_format?: RecraftImageFormat;
+ response_format?: RecraftResponseFormat;
}
export interface RecraftProcessImageResponse {
- created: number;
- credits: number;
- image: RecraftImage;
+ created: number;
+ credits: number;
+ image: RecraftImage;
}
-export type RecraftResponseFormat =
- (typeof RecraftResponseFormat)[keyof typeof RecraftResponseFormat];
+export type RecraftResponseFormat = typeof RecraftResponseFormat[keyof typeof RecraftResponseFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RecraftResponseFormat = {
- url: "url",
- b64_json: "b64_json",
+ url: 'url',
+ b64_json: 'b64_json',
} as const;
export type RecraftTextLayout = RecraftTextLayoutItem[];
export interface RecraftTextLayoutItem {
- bbox: number[][];
- text: string;
+ bbox: number[][];
+ text: string;
}
export interface RecraftTransformImageWithMaskRequest {
- block_nsfw?: boolean;
- calculate_features?: boolean;
- image: Blob;
- image_format?: RecraftImageFormat;
- mask: Blob;
- model?: RecraftTransformModel;
- n?: number;
- negative_prompt?: string;
- prompt: string;
- response_format?: RecraftResponseFormat;
- style?: RecraftImageStyle;
- style_id?: string;
- substyle?: RecraftImageSubStyle;
- text_layout?: RecraftTextLayout;
-}
-
-export type RecraftTransformModel =
- (typeof RecraftTransformModel)[keyof typeof RecraftTransformModel];
+ block_nsfw?: boolean;
+ calculate_features?: boolean;
+ image: Blob;
+ image_format?: RecraftImageFormat;
+ mask: Blob;
+ model?: RecraftTransformModel;
+ n?: number;
+ negative_prompt?: string;
+ prompt: string;
+ response_format?: RecraftResponseFormat;
+ style?: RecraftImageStyle;
+ style_id?: string;
+ substyle?: RecraftImageSubStyle;
+ text_layout?: RecraftTextLayout;
+}
+
+export type RecraftTransformModel = typeof RecraftTransformModel[keyof typeof RecraftTransformModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RecraftTransformModel = {
- refm1: "refm1",
- recraft20b: "recraft20b",
- recraftv2: "recraftv2",
- recraftv3: "recraftv3",
- flux1_1pro: "flux1_1pro",
- flux1dev: "flux1dev",
- imagen3: "imagen3",
- hidream_i1_dev: "hidream_i1_dev",
+ refm1: 'refm1',
+ recraft20b: 'recraft20b',
+ recraftv2: 'recraftv2',
+ recraftv3: 'recraftv3',
+ flux1_1pro: 'flux1_1pro',
+ flux1dev: 'flux1dev',
+ imagen3: 'imagen3',
+ hidream_i1_dev: 'hidream_i1_dev',
} as const;
export interface RecraftUserControls {
- artistic_level?: number;
- background_color?: RecraftImageColor;
- colors?: RecraftImageColor[];
- no_text?: boolean;
+ artistic_level?: number;
+ background_color?: RecraftImageColor;
+ colors?: RecraftImageColor[];
+ no_text?: boolean;
}
/**
* The attention level for this release
*/
-export type ReleaseNoteAttention =
- (typeof ReleaseNoteAttention)[keyof typeof ReleaseNoteAttention];
+export type ReleaseNoteAttention = typeof ReleaseNoteAttention[keyof typeof ReleaseNoteAttention];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReleaseNoteAttention = {
- low: "low",
- medium: "medium",
- high: "high",
+ low: 'low',
+ medium: 'medium',
+ high: 'high',
} as const;
/**
* The project this release note belongs to
*/
-export type ReleaseNoteProject =
- (typeof ReleaseNoteProject)[keyof typeof ReleaseNoteProject];
+export type ReleaseNoteProject = typeof ReleaseNoteProject[keyof typeof ReleaseNoteProject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ReleaseNoteProject = {
- comfyui: "comfyui",
- comfyui_frontend: "comfyui_frontend",
- desktop: "desktop",
+ comfyui: 'comfyui',
+ comfyui_frontend: 'comfyui_frontend',
+ desktop: 'desktop',
} as const;
export interface ReleaseNote {
- /** The attention level for this release */
- attention: ReleaseNoteAttention;
- /** The content of the release note in markdown format */
- content: string;
- /** Unique identifier for the release note */
- id: number;
- /** The project this release note belongs to */
- project: ReleaseNoteProject;
- /** When the release note was published */
- published_at: string;
- /** The version of the release */
- version: string;
+ /** The attention level for this release */
+ attention: ReleaseNoteAttention;
+ /** The content of the release note in markdown format */
+ content: string;
+ /** Unique identifier for the release note */
+ id: number;
+ /** The project this release note belongs to */
+ project: ReleaseNoteProject;
+ /** When the release note was published */
+ published_at: string;
+ /** The version of the release */
+ version: string;
}
/**
* The rendering speed setting that controls the trade-off between generation speed and quality
*/
-export type RenderingSpeed =
- (typeof RenderingSpeed)[keyof typeof RenderingSpeed];
+export type RenderingSpeed = typeof RenderingSpeed[keyof typeof RenderingSpeed];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RenderingSpeed = {
- DEFAULT: "DEFAULT",
- TURBO: "TURBO",
- QUALITY: "QUALITY",
+ DEFAULT: 'DEFAULT',
+ TURBO: 'TURBO',
+ QUALITY: 'QUALITY',
} as const;
/**
* The type of the event. Always `response.completed`.
*/
-export type ResponseCompletedEventType =
- (typeof ResponseCompletedEventType)[keyof typeof ResponseCompletedEventType];
+export type ResponseCompletedEventType = typeof ResponseCompletedEventType[keyof typeof ResponseCompletedEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseCompletedEventType = {
- responsecompleted: "response.completed",
+ responsecompleted: 'response.completed',
} as const;
/**
* Emitted when the model response is complete.
*/
export interface ResponseCompletedEvent {
- response: OpenAIResponse;
- /** The type of the event. Always `response.completed`. */
- type: ResponseCompletedEventType;
+ response: OpenAIResponse;
+ /** The type of the event. Always `response.completed`. */
+ type: ResponseCompletedEventType;
}
/**
* The type of the event. Always `response.content_part.added`.
*/
-export type ResponseContentPartAddedEventType =
- (typeof ResponseContentPartAddedEventType)[keyof typeof ResponseContentPartAddedEventType];
+export type ResponseContentPartAddedEventType = typeof ResponseContentPartAddedEventType[keyof typeof ResponseContentPartAddedEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseContentPartAddedEventType = {
- responsecontent_partadded: "response.content_part.added",
+ responsecontent_partadded: 'response.content_part.added',
} as const;
/**
* Emitted when a new content part is added.
*/
export interface ResponseContentPartAddedEvent {
- /** The index of the content part that was added. */
- content_index: number;
- /** The ID of the output item that the content part was added to. */
- item_id: string;
- /** The index of the output item that the content part was added to. */
- output_index: number;
- part: OutputContent;
- /** The type of the event. Always `response.content_part.added`. */
- type: ResponseContentPartAddedEventType;
+ /** The index of the content part that was added. */
+ content_index: number;
+ /** The ID of the output item that the content part was added to. */
+ item_id: string;
+ /** The index of the output item that the content part was added to. */
+ output_index: number;
+ part: OutputContent;
+ /** The type of the event. Always `response.content_part.added`. */
+ type: ResponseContentPartAddedEventType;
}
/**
* The type of the event. Always `response.content_part.done`.
*/
-export type ResponseContentPartDoneEventType =
- (typeof ResponseContentPartDoneEventType)[keyof typeof ResponseContentPartDoneEventType];
+export type ResponseContentPartDoneEventType = typeof ResponseContentPartDoneEventType[keyof typeof ResponseContentPartDoneEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseContentPartDoneEventType = {
- responsecontent_partdone: "response.content_part.done",
+ responsecontent_partdone: 'response.content_part.done',
} as const;
/**
* Emitted when a content part is done.
*/
export interface ResponseContentPartDoneEvent {
- /** The index of the content part that is done. */
- content_index: number;
- /** The ID of the output item that the content part was added to. */
- item_id: string;
- /** The index of the output item that the content part was added to. */
- output_index: number;
- part: OutputContent;
- /** The type of the event. Always `response.content_part.done`. */
- type: ResponseContentPartDoneEventType;
+ /** The index of the content part that is done. */
+ content_index: number;
+ /** The ID of the output item that the content part was added to. */
+ item_id: string;
+ /** The index of the output item that the content part was added to. */
+ output_index: number;
+ part: OutputContent;
+ /** The type of the event. Always `response.content_part.done`. */
+ type: ResponseContentPartDoneEventType;
}
/**
* The type of the event. Always `response.created`.
*/
-export type ResponseCreatedEventType =
- (typeof ResponseCreatedEventType)[keyof typeof ResponseCreatedEventType];
+export type ResponseCreatedEventType = typeof ResponseCreatedEventType[keyof typeof ResponseCreatedEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseCreatedEventType = {
- responsecreated: "response.created",
+ responsecreated: 'response.created',
} as const;
/**
* An event that is emitted when a response is created.
*/
export interface ResponseCreatedEvent {
- response: OpenAIResponse;
- /** The type of the event. Always `response.created`. */
- type: ResponseCreatedEventType;
+ response: OpenAIResponse;
+ /** The type of the event. Always `response.created`. */
+ type: ResponseCreatedEventType;
}
/**
* An error object returned when the model fails to generate a Response.
*/
export interface ResponseError {
- code: ResponseErrorCode;
- /** A human-readable description of the error. */
- message: string;
+ code: ResponseErrorCode;
+ /** A human-readable description of the error. */
+ message: string;
}
/**
* The error code for the response.
*/
-export type ResponseErrorCode =
- (typeof ResponseErrorCode)[keyof typeof ResponseErrorCode];
+export type ResponseErrorCode = typeof ResponseErrorCode[keyof typeof ResponseErrorCode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseErrorCode = {
- server_error: "server_error",
- rate_limit_exceeded: "rate_limit_exceeded",
- invalid_prompt: "invalid_prompt",
- vector_store_timeout: "vector_store_timeout",
- invalid_image: "invalid_image",
- invalid_image_format: "invalid_image_format",
- invalid_base64_image: "invalid_base64_image",
- invalid_image_url: "invalid_image_url",
- image_too_large: "image_too_large",
- image_too_small: "image_too_small",
- image_parse_error: "image_parse_error",
- image_content_policy_violation: "image_content_policy_violation",
- invalid_image_mode: "invalid_image_mode",
- image_file_too_large: "image_file_too_large",
- unsupported_image_media_type: "unsupported_image_media_type",
- empty_image_file: "empty_image_file",
- failed_to_download_image: "failed_to_download_image",
- image_file_not_found: "image_file_not_found",
+ server_error: 'server_error',
+ rate_limit_exceeded: 'rate_limit_exceeded',
+ invalid_prompt: 'invalid_prompt',
+ vector_store_timeout: 'vector_store_timeout',
+ invalid_image: 'invalid_image',
+ invalid_image_format: 'invalid_image_format',
+ invalid_base64_image: 'invalid_base64_image',
+ invalid_image_url: 'invalid_image_url',
+ image_too_large: 'image_too_large',
+ image_too_small: 'image_too_small',
+ image_parse_error: 'image_parse_error',
+ image_content_policy_violation: 'image_content_policy_violation',
+ invalid_image_mode: 'invalid_image_mode',
+ image_file_too_large: 'image_file_too_large',
+ unsupported_image_media_type: 'unsupported_image_media_type',
+ empty_image_file: 'empty_image_file',
+ failed_to_download_image: 'failed_to_download_image',
+ image_file_not_found: 'image_file_not_found',
} as const;
/**
* The type of the event. Always `error`.
*/
-export type ResponseErrorEventType =
- (typeof ResponseErrorEventType)[keyof typeof ResponseErrorEventType];
+export type ResponseErrorEventType = typeof ResponseErrorEventType[keyof typeof ResponseErrorEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseErrorEventType = {
- error: "error",
+ error: 'error',
} as const;
/**
* Emitted when an error occurs.
*/
export interface ResponseErrorEvent {
- /** The error code.
- */
- code: string;
- /** The error message.
- */
- message: string;
- /** The error parameter.
- */
- param: string;
- /** The type of the event. Always `error`.
- */
- type: ResponseErrorEventType;
+ /** The error code.
+ */
+ code: string;
+ /** The error message.
+ */
+ message: string;
+ /** The error parameter.
+ */
+ param: string;
+ /** The type of the event. Always `error`.
+ */
+ type: ResponseErrorEventType;
}
/**
* The type of the event. Always `response.failed`.
*/
-export type ResponseFailedEventType =
- (typeof ResponseFailedEventType)[keyof typeof ResponseFailedEventType];
+export type ResponseFailedEventType = typeof ResponseFailedEventType[keyof typeof ResponseFailedEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseFailedEventType = {
- responsefailed: "response.failed",
+ responsefailed: 'response.failed',
} as const;
/**
@@ -5567,21 +5674,21 @@ export const ResponseFailedEventType = {
*/
export interface ResponseFailedEvent {
- response: OpenAIResponse;
- /** The type of the event. Always `response.failed`.
- */
- type: ResponseFailedEventType;
+ response: OpenAIResponse;
+ /** The type of the event. Always `response.failed`.
+ */
+ type: ResponseFailedEventType;
}
/**
* The type of response format being defined. Always `json_object`.
*/
-export type ResponseFormatJsonObjectType =
- (typeof ResponseFormatJsonObjectType)[keyof typeof ResponseFormatJsonObjectType];
+export type ResponseFormatJsonObjectType = typeof ResponseFormatJsonObjectType[keyof typeof ResponseFormatJsonObjectType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseFormatJsonObjectType = {
- json_object: "json_object",
+ json_object: 'json_object',
} as const;
/**
@@ -5592,8 +5699,8 @@ to do so.
*/
export interface ResponseFormatJsonObject {
- /** The type of response format being defined. Always `json_object`. */
- type: ResponseFormatJsonObjectType;
+ /** The type of response format being defined. Always `json_object`. */
+ type: ResponseFormatJsonObjectType;
}
/**
@@ -5601,19 +5708,17 @@ export interface ResponseFormatJsonObject {
Learn how to build JSON schemas [here](https://json-schema.org/).
*/
-export interface ResponseFormatJsonSchemaSchema {
- [key: string]: unknown;
-}
+export interface ResponseFormatJsonSchemaSchema { [key: string]: unknown }
/**
* The type of response format being defined. Always `text`.
*/
-export type ResponseFormatTextType =
- (typeof ResponseFormatTextType)[keyof typeof ResponseFormatTextType];
+export type ResponseFormatTextType = typeof ResponseFormatTextType[keyof typeof ResponseFormatTextType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseFormatTextType = {
- text: "text",
+ text: 'text',
} as const;
/**
@@ -5621,42 +5726,42 @@ export const ResponseFormatTextType = {
*/
export interface ResponseFormatText {
- /** The type of response format being defined. Always `text`. */
- type: ResponseFormatTextType;
+ /** The type of response format being defined. Always `text`. */
+ type: ResponseFormatTextType;
}
/**
* The type of the event. Always `response.in_progress`.
*/
-export type ResponseInProgressEventType =
- (typeof ResponseInProgressEventType)[keyof typeof ResponseInProgressEventType];
+export type ResponseInProgressEventType = typeof ResponseInProgressEventType[keyof typeof ResponseInProgressEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseInProgressEventType = {
- responsein_progress: "response.in_progress",
+ responsein_progress: 'response.in_progress',
} as const;
/**
* Emitted when the response is in progress.
*/
export interface ResponseInProgressEvent {
- response: OpenAIResponse;
- /** The type of the event. Always `response.in_progress`.
- */
- type: ResponseInProgressEventType;
+ response: OpenAIResponse;
+ /** The type of the event. Always `response.in_progress`.
+ */
+ type: ResponseInProgressEventType;
}
/**
* The type of the event. Always `response.incomplete`.
*/
-export type ResponseIncompleteEventType =
- (typeof ResponseIncompleteEventType)[keyof typeof ResponseIncompleteEventType];
+export type ResponseIncompleteEventType = typeof ResponseIncompleteEventType[keyof typeof ResponseIncompleteEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseIncompleteEventType = {
- responseincomplete: "response.incomplete",
+ responseincomplete: 'response.incomplete',
} as const;
/**
@@ -5664,64 +5769,64 @@ export const ResponseIncompleteEventType = {
*/
export interface ResponseIncompleteEvent {
- response: OpenAIResponse;
- /** The type of the event. Always `response.incomplete`.
- */
- type: ResponseIncompleteEventType;
+ response: OpenAIResponse;
+ /** The type of the event. Always `response.incomplete`.
+ */
+ type: ResponseIncompleteEventType;
}
/**
* The type of the event. Always `response.output_item.added`.
*/
-export type ResponseOutputItemAddedEventType =
- (typeof ResponseOutputItemAddedEventType)[keyof typeof ResponseOutputItemAddedEventType];
+export type ResponseOutputItemAddedEventType = typeof ResponseOutputItemAddedEventType[keyof typeof ResponseOutputItemAddedEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseOutputItemAddedEventType = {
- responseoutput_itemadded: "response.output_item.added",
+ responseoutput_itemadded: 'response.output_item.added',
} as const;
/**
* Emitted when a new output item is added.
*/
export interface ResponseOutputItemAddedEvent {
- item: OutputItem;
- /** The index of the output item that was added.
- */
- output_index: number;
- /** The type of the event. Always `response.output_item.added`.
- */
- type: ResponseOutputItemAddedEventType;
+ item: OutputItem;
+ /** The index of the output item that was added.
+ */
+ output_index: number;
+ /** The type of the event. Always `response.output_item.added`.
+ */
+ type: ResponseOutputItemAddedEventType;
}
/**
* The type of the event. Always `response.output_item.done`.
*/
-export type ResponseOutputItemDoneEventType =
- (typeof ResponseOutputItemDoneEventType)[keyof typeof ResponseOutputItemDoneEventType];
+export type ResponseOutputItemDoneEventType = typeof ResponseOutputItemDoneEventType[keyof typeof ResponseOutputItemDoneEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponseOutputItemDoneEventType = {
- responseoutput_itemdone: "response.output_item.done",
+ responseoutput_itemdone: 'response.output_item.done',
} as const;
/**
* Emitted when an output item is marked done.
*/
export interface ResponseOutputItemDoneEvent {
- item: OutputItem;
- /** The index of the output item that was marked done.
- */
- output_index: number;
- /** The type of the event. Always `response.output_item.done`.
- */
- type: ResponseOutputItemDoneEventType;
+ item: OutputItem;
+ /** The index of the output item that was marked done.
+ */
+ output_index: number;
+ /** The type of the event. Always `response.output_item.done`.
+ */
+ type: ResponseOutputItemDoneEventType;
}
export type ResponsePropertiesText = {
- format?: TextResponseFormatConfiguration;
+ format?: TextResponseFormatConfiguration;
};
/**
@@ -5730,10 +5835,7 @@ a response. See the `tools` parameter to see how to specify which tools
the model can call.
*/
-export type ResponsePropertiesToolChoice =
- | ToolChoiceOptions
- | ToolChoiceTypes
- | ToolChoiceFunction;
+export type ResponsePropertiesToolChoice = ToolChoiceOptions | ToolChoiceTypes | ToolChoiceFunction;
/**
* The truncation strategy to use for the model response.
@@ -5745,41 +5847,41 @@ export type ResponsePropertiesToolChoice =
size for a model, the request will fail with a 400 error.
*/
-export type ResponsePropertiesTruncation =
- (typeof ResponsePropertiesTruncation)[keyof typeof ResponsePropertiesTruncation];
+export type ResponsePropertiesTruncation = typeof ResponsePropertiesTruncation[keyof typeof ResponsePropertiesTruncation];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ResponsePropertiesTruncation = {
- auto: "auto",
- disabled: "disabled",
+ auto: 'auto',
+ disabled: 'disabled',
} as const;
export interface ResponseProperties {
- /** Inserts a system (or developer) message as the first item in the model's context.
+ /** Inserts a system (or developer) message as the first item in the model's context.
When using along with `previous_response_id`, the instructions from a previous
response will not be carried over to the next response. This makes it simple
to swap out system (or developer) messages in new responses.
*/
- instructions?: string;
- /** An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
- */
- max_output_tokens?: number;
- model?: OpenAIModels;
- /** The unique ID of the previous response to the model. Use this to
+ instructions?: string;
+ /** An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
+ */
+ max_output_tokens?: number;
+ model?: OpenAIModels;
+ /** The unique ID of the previous response to the model. Use this to
create multi-turn conversations. Learn more about
[conversation state](/docs/guides/conversation-state).
*/
- previous_response_id?: string;
- reasoning?: Reasoning;
- text?: ResponsePropertiesText;
- /** How the model should select which tool (or tools) to use when generating
+ previous_response_id?: string;
+ reasoning?: Reasoning;
+ text?: ResponsePropertiesText;
+ /** How the model should select which tool (or tools) to use when generating
a response. See the `tools` parameter to see how to specify which tools
the model can call.
*/
- tool_choice?: ResponsePropertiesToolChoice;
- tools?: Tool[];
- /** The truncation strategy to use for the model response.
+ tool_choice?: ResponsePropertiesToolChoice;
+ tools?: Tool[];
+ /** The truncation strategy to use for the model response.
- `auto`: If the context of this response and previous ones exceeds
the model's context window size, the model will truncate the
response to fit the context window by dropping input items in the
@@ -5787,25 +5889,25 @@ the model can call.
- `disabled` (default): If a model response will exceed the context window
size for a model, the request will fail with a 400 error.
*/
- truncation?: ResponsePropertiesTruncation;
+ truncation?: ResponsePropertiesTruncation;
}
/**
* A detailed breakdown of the input tokens.
*/
export type ResponseUsageInputTokensDetails = {
- /** The number of tokens that were retrieved from the cache.
+ /** The number of tokens that were retrieved from the cache.
[More on prompt caching](/docs/guides/prompt-caching).
*/
- cached_tokens: number;
+ cached_tokens: number;
};
/**
* A detailed breakdown of the output tokens.
*/
export type ResponseUsageOutputTokensDetails = {
- /** The number of reasoning tokens. */
- reasoning_tokens: number;
+ /** The number of reasoning tokens. */
+ reasoning_tokens: number;
};
/**
@@ -5814,344 +5916,343 @@ a breakdown of output tokens, and the total tokens used.
*/
export interface ResponseUsage {
- /** The number of input tokens. */
- input_tokens: number;
- /** A detailed breakdown of the input tokens. */
- input_tokens_details: ResponseUsageInputTokensDetails;
- /** The number of output tokens. */
- output_tokens: number;
- /** A detailed breakdown of the output tokens. */
- output_tokens_details: ResponseUsageOutputTokensDetails;
- /** The total number of tokens used. */
- total_tokens: number;
+ /** The number of input tokens. */
+ input_tokens: number;
+ /** A detailed breakdown of the input tokens. */
+ input_tokens_details: ResponseUsageInputTokensDetails;
+ /** The number of output tokens. */
+ output_tokens: number;
+ /** A detailed breakdown of the output tokens. */
+ output_tokens_details: ResponseUsageOutputTokensDetails;
+ /** The total number of tokens used. */
+ total_tokens: number;
}
export interface Rodin3DCheckStatusRequest {
- /** subscription from generate endpoint */
- subscription_key: string;
+ /** subscription from generate endpoint */
+ subscription_key: string;
}
export interface Rodin3DCheckStatusResponse {
- /** Details for the generation status. */
- jobs?: RodinCheckStatusJobItem[];
+ /** Details for the generation status. */
+ jobs?: RodinCheckStatusJobItem[];
}
export interface Rodin3DDownloadRequest {
- /** Task UUID */
- task_uuid: string;
+ /** Task UUID */
+ task_uuid: string;
}
export interface Rodin3DDownloadResponse {
- list?: RodinResourceItem[];
+ list?: RodinResourceItem[];
}
export interface Rodin3DGenerateRequest {
- /** The reference images to generate 3D Assets. */
- images: string;
- material?: RodinMaterialType;
- mesh_mode?: RodinMeshModeType;
- quality?: RodinQualityType;
- /** Seed. */
- seed?: number;
- tier?: RodinTierType;
+ /** The reference images to generate 3D Assets. */
+ images: string;
+ material?: RodinMaterialType;
+ mesh_mode?: RodinMeshModeType;
+ quality?: RodinQualityType;
+ /** Seed. */
+ seed?: number;
+ tier?: RodinTierType;
}
export interface Rodin3DGenerateResponse {
- jobs?: RodinGenerateJobsData;
- /** message */
- message?: string;
- /** prompt */
- prompt?: string;
- /** Time */
- submit_time?: string;
- /** Task UUID */
- uuid?: string;
+ jobs?: RodinGenerateJobsData;
+ /** message */
+ message?: string;
+ /** prompt */
+ prompt?: string;
+ /** Time */
+ submit_time?: string;
+ /** Task UUID */
+ uuid?: string;
}
export interface RodinCheckStatusJobItem {
- status?: RodinStatusOptions;
- /** sub uuid */
- uuid?: string;
+ status?: RodinStatusOptions;
+ /** sub uuid */
+ uuid?: string;
}
export interface RodinGenerateJobsData {
- /** Subscription Key. */
- subscription_key?: string;
- /** subjobs uuid. */
- uuids?: string[];
+ /** Subscription Key. */
+ subscription_key?: string;
+ /** subjobs uuid. */
+ uuids?: string[];
}
/**
* Rodin Material para options
*/
-export type RodinMaterialType =
- (typeof RodinMaterialType)[keyof typeof RodinMaterialType];
+export type RodinMaterialType = typeof RodinMaterialType[keyof typeof RodinMaterialType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RodinMaterialType = {
- PBR: "PBR",
- Shaded: "Shaded",
+ PBR: 'PBR',
+ Shaded: 'Shaded',
} as const;
/**
* Rodin Mesh_Mode para options
*/
-export type RodinMeshModeType =
- (typeof RodinMeshModeType)[keyof typeof RodinMeshModeType];
+export type RodinMeshModeType = typeof RodinMeshModeType[keyof typeof RodinMeshModeType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RodinMeshModeType = {
- Quad: "Quad",
- Raw: "Raw",
+ Quad: 'Quad',
+ Raw: 'Raw',
} as const;
/**
* Rodin Quality para options
*/
-export type RodinQualityType =
- (typeof RodinQualityType)[keyof typeof RodinQualityType];
+export type RodinQualityType = typeof RodinQualityType[keyof typeof RodinQualityType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RodinQualityType = {
- "extra-low": "extra-low",
- low: "low",
- medium: "medium",
- high: "high",
+ 'extra-low': 'extra-low',
+ low: 'low',
+ medium: 'medium',
+ high: 'high',
} as const;
export interface RodinResourceItem {
- /** File name */
- name?: string;
- /** Download url */
- url?: string;
+ /** File name */
+ name?: string;
+ /** Download url */
+ url?: string;
}
-export type RodinStatusOptions =
- (typeof RodinStatusOptions)[keyof typeof RodinStatusOptions];
+export type RodinStatusOptions = typeof RodinStatusOptions[keyof typeof RodinStatusOptions];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RodinStatusOptions = {
- Done: "Done",
- Failed: "Failed",
- Generating: "Generating",
- Waiting: "Waiting",
+ Done: 'Done',
+ Failed: 'Failed',
+ Generating: 'Generating',
+ Waiting: 'Waiting',
} as const;
/**
* Rodin Tier para options
*/
-export type RodinTierType = (typeof RodinTierType)[keyof typeof RodinTierType];
+export type RodinTierType = typeof RodinTierType[keyof typeof RodinTierType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RodinTierType = {
- Regular: "Regular",
- Sketch: "Sketch",
- Detail: "Detail",
- Smooth: "Smooth",
+ Regular: 'Regular',
+ Sketch: 'Sketch',
+ Detail: 'Detail',
+ Smooth: 'Smooth',
} as const;
-export type RunwayAspectRatioEnum =
- (typeof RunwayAspectRatioEnum)[keyof typeof RunwayAspectRatioEnum];
+export type RunwayAspectRatioEnum = typeof RunwayAspectRatioEnum[keyof typeof RunwayAspectRatioEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayAspectRatioEnum = {
- "1280:720": "1280:720",
- "720:1280": "720:1280",
- "1104:832": "1104:832",
- "832:1104": "832:1104",
- "960:960": "960:960",
- "1584:672": "1584:672",
- "1280:768": "1280:768",
- "768:1280": "768:1280",
+ '1280:720': '1280:720',
+ '720:1280': '720:1280',
+ '1104:832': '1104:832',
+ '832:1104': '832:1104',
+ '960:960': '960:960',
+ '1584:672': '1584:672',
+ '1280:768': '1280:768',
+ '768:1280': '768:1280',
} as const;
-export type RunwayDurationEnum =
- (typeof RunwayDurationEnum)[keyof typeof RunwayDurationEnum];
+export type RunwayDurationEnum = typeof RunwayDurationEnum[keyof typeof RunwayDurationEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayDurationEnum = {
- NUMBER_5: 5,
- NUMBER_10: 10,
+ NUMBER_5: 5,
+ NUMBER_10: 10,
} as const;
export interface RunwayImageToVideoRequest {
- duration: RunwayDurationEnum;
- model: RunwayModelEnum;
- promptImage: RunwayPromptImageObject;
- /**
- * Text prompt for the generation
- * @maxLength 1000
- */
- promptText?: string;
- ratio: RunwayAspectRatioEnum;
- /**
- * Random seed for generation
- * @minimum 0
- * @maximum 4294967295
- */
- seed: number;
+ duration: RunwayDurationEnum;
+ model: RunwayModelEnum;
+ promptImage: RunwayPromptImageObject;
+ /**
+ * Text prompt for the generation
+ * @maxLength 1000
+ */
+ promptText?: string;
+ ratio: RunwayAspectRatioEnum;
+ /**
+ * Random seed for generation
+ * @minimum 0
+ * @maximum 4294967295
+ */
+ seed: number;
}
export interface RunwayImageToVideoResponse {
- /** Task ID */
- id?: string;
+ /** Task ID */
+ id?: string;
}
/**
* Available Runway models for generation.
*/
-export type RunwayModelEnum =
- (typeof RunwayModelEnum)[keyof typeof RunwayModelEnum];
+export type RunwayModelEnum = typeof RunwayModelEnum[keyof typeof RunwayModelEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayModelEnum = {
- gen4_turbo: "gen4_turbo",
- gen3a_turbo: "gen3a_turbo",
+ gen4_turbo: 'gen4_turbo',
+ gen3a_turbo: 'gen3a_turbo',
} as const;
/**
* The position of the image in the output video. 'last' is currently supported for gen3a_turbo only.
*/
-export type RunwayPromptImageDetailedObjectPosition =
- (typeof RunwayPromptImageDetailedObjectPosition)[keyof typeof RunwayPromptImageDetailedObjectPosition];
+export type RunwayPromptImageDetailedObjectPosition = typeof RunwayPromptImageDetailedObjectPosition[keyof typeof RunwayPromptImageDetailedObjectPosition];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayPromptImageDetailedObjectPosition = {
- first: "first",
- last: "last",
+ first: 'first',
+ last: 'last',
} as const;
/**
* Represents an image with its position in the video sequence.
*/
export interface RunwayPromptImageDetailedObject {
- /** The position of the image in the output video. 'last' is currently supported for gen3a_turbo only. */
- position: RunwayPromptImageDetailedObjectPosition;
- /** A HTTPS URL or data URI containing an encoded image. */
- uri: string;
+ /** The position of the image in the output video. 'last' is currently supported for gen3a_turbo only. */
+ position: RunwayPromptImageDetailedObjectPosition;
+ /** A HTTPS URL or data URI containing an encoded image. */
+ uri: string;
}
/**
* Image(s) to use for the video generation. Can be a single URI or an array of image objects with positions.
*/
-export type RunwayPromptImageObject =
- | string
- | RunwayPromptImageDetailedObject[];
+export type RunwayPromptImageObject = string | RunwayPromptImageDetailedObject[];
/**
* Possible statuses for a Runway task.
*/
-export type RunwayTaskStatusEnum =
- (typeof RunwayTaskStatusEnum)[keyof typeof RunwayTaskStatusEnum];
+export type RunwayTaskStatusEnum = typeof RunwayTaskStatusEnum[keyof typeof RunwayTaskStatusEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayTaskStatusEnum = {
- SUCCEEDED: "SUCCEEDED",
- RUNNING: "RUNNING",
- FAILED: "FAILED",
- PENDING: "PENDING",
- CANCELLED: "CANCELLED",
- THROTTLED: "THROTTLED",
+ SUCCEEDED: 'SUCCEEDED',
+ RUNNING: 'RUNNING',
+ FAILED: 'FAILED',
+ PENDING: 'PENDING',
+ CANCELLED: 'CANCELLED',
+ THROTTLED: 'THROTTLED',
} as const;
export interface RunwayTaskStatusResponse {
- /** Task creation timestamp */
- createdAt: string;
- /** Task ID */
- id: string;
- /** Array of output video URLs */
- output?: string[];
- /**
- * Float value between 0 and 1 representing the progress of the task. Only available if status is RUNNING.
- * @minimum 0
- * @maximum 1
- */
- progress?: number;
- status: RunwayTaskStatusEnum;
+ /** Task creation timestamp */
+ createdAt: string;
+ /** Task ID */
+ id: string;
+ /** Array of output video URLs */
+ output?: string[];
+ /**
+ * Float value between 0 and 1 representing the progress of the task. Only available if status is RUNNING.
+ * @minimum 0
+ * @maximum 1
+ */
+ progress?: number;
+ status: RunwayTaskStatusEnum;
}
-export type RunwayTextToImageAspectRatioEnum =
- (typeof RunwayTextToImageAspectRatioEnum)[keyof typeof RunwayTextToImageAspectRatioEnum];
+export type RunwayTextToImageAspectRatioEnum = typeof RunwayTextToImageAspectRatioEnum[keyof typeof RunwayTextToImageAspectRatioEnum];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayTextToImageAspectRatioEnum = {
- "1920:1080": "1920:1080",
- "1080:1920": "1080:1920",
- "1024:1024": "1024:1024",
- "1360:768": "1360:768",
- "1080:1080": "1080:1080",
- "1168:880": "1168:880",
- "1440:1080": "1440:1080",
- "1080:1440": "1080:1440",
- "1808:768": "1808:768",
- "2112:912": "2112:912",
+ '1920:1080': '1920:1080',
+ '1080:1920': '1080:1920',
+ '1024:1024': '1024:1024',
+ '1360:768': '1360:768',
+ '1080:1080': '1080:1080',
+ '1168:880': '1168:880',
+ '1440:1080': '1440:1080',
+ '1080:1440': '1080:1440',
+ '1808:768': '1808:768',
+ '2112:912': '2112:912',
} as const;
/**
* Model to use for generation
*/
-export type RunwayTextToImageRequestModel =
- (typeof RunwayTextToImageRequestModel)[keyof typeof RunwayTextToImageRequestModel];
+export type RunwayTextToImageRequestModel = typeof RunwayTextToImageRequestModel[keyof typeof RunwayTextToImageRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RunwayTextToImageRequestModel = {
- gen4_image: "gen4_image",
+ gen4_image: 'gen4_image',
} as const;
export type RunwayTextToImageRequestReferenceImagesItem = {
- /** A HTTPS URL or data URI containing an encoded image */
- uri?: string;
+ /** A HTTPS URL or data URI containing an encoded image */
+ uri?: string;
};
export interface RunwayTextToImageRequest {
- /** Model to use for generation */
- model: RunwayTextToImageRequestModel;
- /**
- * Text prompt for the image generation
- * @maxLength 1000
- */
- promptText: string;
- ratio: RunwayTextToImageAspectRatioEnum;
- /** Array of reference images to guide the generation */
- referenceImages?: RunwayTextToImageRequestReferenceImagesItem[];
+ /** Model to use for generation */
+ model: RunwayTextToImageRequestModel;
+ /**
+ * Text prompt for the image generation
+ * @maxLength 1000
+ */
+ promptText: string;
+ ratio: RunwayTextToImageAspectRatioEnum;
+ /** Array of reference images to guide the generation */
+ referenceImages?: RunwayTextToImageRequestReferenceImagesItem[];
}
export interface RunwayTextToImageResponse {
- /** Task ID */
- id?: string;
+ /** Task ID */
+ id?: string;
}
/**
* Our content moderation system has flagged some part of your request and subsequently denied it. You were not charged for this request. While this may at times be frustrating, it is necessary to maintain the integrity of our platform and ensure a safe experience for all users. If you would like to provide feedback, please use the [Support Form](https://kb.stability.ai/knowledge-base/kb-tickets/new).
* @minLength 1
*/
-export type StabilityContentModerationResponseName =
- (typeof StabilityContentModerationResponseName)[keyof typeof StabilityContentModerationResponseName];
+export type StabilityContentModerationResponseName = typeof StabilityContentModerationResponseName[keyof typeof StabilityContentModerationResponseName];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityContentModerationResponseName = {
- content_moderation: "content_moderation",
+ content_moderation: 'content_moderation',
} as const;
/**
* Your request was flagged by our content moderation system.
*/
export interface StabilityContentModerationResponse {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Our content moderation system has flagged some part of your request and subsequently denied it. You were not charged for this request. While this may at times be frustrating, it is necessary to maintain the integrity of our platform and ensure a safe experience for all users. If you would like to provide feedback, please use the [Support Form](https://kb.stability.ai/knowledge-base/kb-tickets/new).
- * @minLength 1
- */
- name: StabilityContentModerationResponseName;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Our content moderation system has flagged some part of your request and subsequently denied it. You were not charged for this request. While this may at times be frustrating, it is necessary to maintain the integrity of our platform and ensure a safe experience for all users. If you would like to provide feedback, please use the [Support Form](https://kb.stability.ai/knowledge-base/kb-tickets/new).
+ * @minLength 1
+ */
+ name: StabilityContentModerationResponseName;
}
/**
@@ -6162,22 +6263,22 @@ export interface StabilityContentModerationResponse {
export type StabilityCreativity = number;
export interface StabilityError {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
/**
@@ -6187,18 +6288,18 @@ export interface StabilityError {
*/
export type StabilityGenerationID = string;
-export type StabilityGetResultResponse202Status =
- (typeof StabilityGetResultResponse202Status)[keyof typeof StabilityGetResultResponse202Status];
+export type StabilityGetResultResponse202Status = typeof StabilityGetResultResponse202Status[keyof typeof StabilityGetResultResponse202Status];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityGetResultResponse202Status = {
- "in-progress": "in-progress",
+ 'in-progress': 'in-progress',
} as const;
export interface StabilityGetResultResponse202 {
- /** The ID of the generation result. */
- id?: string;
- status?: StabilityGetResultResponse202Status;
+ /** The ID of the generation result. */
+ id?: string;
+ status?: StabilityGetResultResponse202Status;
}
/**
@@ -6206,20 +6307,20 @@ export interface StabilityGetResultResponse202 {
> **Important:** This parameter is only valid for **text-to-image** requests.
*/
-export type StabilityImageGenerationSD3RequestAspectRatio =
- (typeof StabilityImageGenerationSD3RequestAspectRatio)[keyof typeof StabilityImageGenerationSD3RequestAspectRatio];
+export type StabilityImageGenerationSD3RequestAspectRatio = typeof StabilityImageGenerationSD3RequestAspectRatio[keyof typeof StabilityImageGenerationSD3RequestAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenerationSD3RequestAspectRatio = {
- "21:9": "21:9",
- "16:9": "16:9",
- "3:2": "3:2",
- "5:4": "5:4",
- "1:1": "1:1",
- "4:5": "4:5",
- "2:3": "2:3",
- "9:16": "9:16",
- "9:21": "9:21",
+ '21:9': '21:9',
+ '16:9': '16:9',
+ '3:2': '3:2',
+ '5:4': '5:4',
+ '1:1': '1:1',
+ '4:5': '4:5',
+ '2:3': '2:3',
+ '9:16': '9:16',
+ '9:21': '9:21',
} as const;
/**
@@ -6227,13 +6328,13 @@ export const StabilityImageGenerationSD3RequestAspectRatio = {
- **text-to-image** requires only the `prompt` parameter
- **image-to-image** requires the `prompt`, `image`, and `strength` parameters
*/
-export type StabilityImageGenerationSD3RequestMode =
- (typeof StabilityImageGenerationSD3RequestMode)[keyof typeof StabilityImageGenerationSD3RequestMode];
+export type StabilityImageGenerationSD3RequestMode = typeof StabilityImageGenerationSD3RequestMode[keyof typeof StabilityImageGenerationSD3RequestMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenerationSD3RequestMode = {
- "text-to-image": "text-to-image",
- "image-to-image": "image-to-image",
+ 'text-to-image': 'text-to-image',
+ 'image-to-image': 'image-to-image',
} as const;
/**
@@ -6248,67 +6349,67 @@ export const StabilityImageGenerationSD3RequestMode = {
are re-routed to their `sd3.5-[model version]` equivalent, at the same price.
*/
-export type StabilityImageGenerationSD3RequestModel =
- (typeof StabilityImageGenerationSD3RequestModel)[keyof typeof StabilityImageGenerationSD3RequestModel];
+export type StabilityImageGenerationSD3RequestModel = typeof StabilityImageGenerationSD3RequestModel[keyof typeof StabilityImageGenerationSD3RequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenerationSD3RequestModel = {
- "sd35-large": "sd3.5-large",
- "sd35-large-turbo": "sd3.5-large-turbo",
- "sd35-medium": "sd3.5-medium",
+ 'sd35-large': 'sd3.5-large',
+ 'sd35-large-turbo': 'sd3.5-large-turbo',
+ 'sd35-medium': 'sd3.5-medium',
} as const;
/**
* Dictates the `content-type` of the generated image.
*/
-export type StabilityImageGenerationSD3RequestOutputFormat =
- (typeof StabilityImageGenerationSD3RequestOutputFormat)[keyof typeof StabilityImageGenerationSD3RequestOutputFormat];
+export type StabilityImageGenerationSD3RequestOutputFormat = typeof StabilityImageGenerationSD3RequestOutputFormat[keyof typeof StabilityImageGenerationSD3RequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenerationSD3RequestOutputFormat = {
- png: "png",
- jpeg: "jpeg",
+ png: 'png',
+ jpeg: 'jpeg',
} as const;
/**
* Guides the image model towards a particular style.
*/
-export type StabilityImageGenerationSD3RequestStylePreset =
- (typeof StabilityImageGenerationSD3RequestStylePreset)[keyof typeof StabilityImageGenerationSD3RequestStylePreset];
+export type StabilityImageGenerationSD3RequestStylePreset = typeof StabilityImageGenerationSD3RequestStylePreset[keyof typeof StabilityImageGenerationSD3RequestStylePreset];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenerationSD3RequestStylePreset = {
- enhance: "enhance",
- anime: "anime",
- photographic: "photographic",
- "digital-art": "digital-art",
- "comic-book": "comic-book",
- "fantasy-art": "fantasy-art",
- "line-art": "line-art",
- "analog-film": "analog-film",
- "neon-punk": "neon-punk",
- isometric: "isometric",
- "low-poly": "low-poly",
- origami: "origami",
- "modeling-compound": "modeling-compound",
- cinematic: "cinematic",
- "3d-model": "3d-model",
- "pixel-art": "pixel-art",
- "tile-texture": "tile-texture",
+ enhance: 'enhance',
+ anime: 'anime',
+ photographic: 'photographic',
+ 'digital-art': 'digital-art',
+ 'comic-book': 'comic-book',
+ 'fantasy-art': 'fantasy-art',
+ 'line-art': 'line-art',
+ 'analog-film': 'analog-film',
+ 'neon-punk': 'neon-punk',
+ isometric: 'isometric',
+ 'low-poly': 'low-poly',
+ origami: 'origami',
+ 'modeling-compound': 'modeling-compound',
+ cinematic: 'cinematic',
+ '3d-model': '3d-model',
+ 'pixel-art': 'pixel-art',
+ 'tile-texture': 'tile-texture',
} as const;
export interface StabilityImageGenerationSD3Request {
- /** Controls the aspect ratio of the generated image. Defaults to 1:1.
+ /** Controls the aspect ratio of the generated image. Defaults to 1:1.
> **Important:** This parameter is only valid for **text-to-image** requests. */
- aspect_ratio?: StabilityImageGenerationSD3RequestAspectRatio;
- /**
- * How strictly the diffusion process adheres to the prompt text (higher values keep your image closer to your prompt). The _Large_ and _Medium_ models use a default of `4`. The _Turbo_ model uses a default of `1`.
- * @minimum 1
- * @maximum 10
- */
- cfg_scale?: number;
- /** The image to use as the starting point for the generation.
+ aspect_ratio?: StabilityImageGenerationSD3RequestAspectRatio;
+ /**
+ * How strictly the diffusion process adheres to the prompt text (higher values keep your image closer to your prompt). The _Large_ and _Medium_ models use a default of `4`. The _Turbo_ model uses a default of `1`.
+ * @minimum 1
+ * @maximum 10
+ */
+ cfg_scale?: number;
+ /** The image to use as the starting point for the generation.
Supported formats:
@@ -6325,12 +6426,12 @@ Supported dimensions:
- Every side must be at least 64 pixels
> **Important:** This parameter is only valid for **image-to-image** requests. */
- image?: Blob;
- /** Controls whether this is a text-to-image or image-to-image generation, which affects which parameters are required:
+ image?: Blob;
+ /** Controls whether this is a text-to-image or image-to-image generation, which affects which parameters are required:
- **text-to-image** requires only the `prompt` parameter
- **image-to-image** requires the `prompt`, `image`, and `strength` parameters */
- mode?: StabilityImageGenerationSD3RequestMode;
- /** The model to use for generation.
+ mode?: StabilityImageGenerationSD3RequestMode;
+ /** The model to use for generation.
- `sd3.5-large` requires 6.5 credits per generation
- `sd3.5-large-turbo` requires 4 credits per generation
@@ -6340,29 +6441,29 @@ Supported dimensions:
are re-routed to their `sd3.5-[model version]` equivalent, at the same price. */
- model?: StabilityImageGenerationSD3RequestModel;
- /**
+ model?: StabilityImageGenerationSD3RequestModel;
+ /**
* Keywords of what you **do not** wish to see in the output image.
This is an advanced feature.
* @maxLength 10000
*/
- negative_prompt?: string;
- /** Dictates the `content-type` of the generated image. */
- output_format?: StabilityImageGenerationSD3RequestOutputFormat;
- /**
+ negative_prompt?: string;
+ /** Dictates the `content-type` of the generated image. */
+ output_format?: StabilityImageGenerationSD3RequestOutputFormat;
+ /**
* What you wish to see in the output image. A strong, descriptive prompt that clearly defines
elements, colors, and subjects will lead to better results.
* @minLength 1
* @maxLength 10000
*/
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /**
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /**
* Sometimes referred to as _denoising_, this parameter controls how much influence the
`image` parameter has on the generated image. A value of 0 would yield an image that
is identical to the input. A value of 1 would be as if you passed in no image at all.
@@ -6371,9 +6472,9 @@ is identical to the input. A value of 1 would be as if you passed in no image a
* @minimum 0
* @maximum 1
*/
- strength?: number;
- /** Guides the image model towards a particular style. */
- style_preset?: StabilityImageGenerationSD3RequestStylePreset;
+ strength?: number;
+ /** Guides the image model towards a particular style. */
+ style_preset?: StabilityImageGenerationSD3RequestStylePreset;
}
/**
@@ -6383,143 +6484,143 @@ is identical to the input. A value of 1 would be as if you passed in no image a
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityImageGenrationSD3Response200FinishReason =
- (typeof StabilityImageGenrationSD3Response200FinishReason)[keyof typeof StabilityImageGenrationSD3Response200FinishReason];
+export type StabilityImageGenrationSD3Response200FinishReason = typeof StabilityImageGenrationSD3Response200FinishReason[keyof typeof StabilityImageGenrationSD3Response200FinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationSD3Response200FinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export interface StabilityImageGenrationSD3Response200 {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationSD3Response200FinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityImageGenrationSD3Response200FinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
}
export interface StabilityImageGenrationSD3Response400 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationSD3Response413 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationSD3Response422 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationSD3Response429 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationSD3Response500 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
/**
* Dictates the `content-type` of the generated image.
*/
-export type StabilityImageGenrationUpscaleConservativeRequestOutputFormat =
- (typeof StabilityImageGenrationUpscaleConservativeRequestOutputFormat)[keyof typeof StabilityImageGenrationUpscaleConservativeRequestOutputFormat];
+export type StabilityImageGenrationUpscaleConservativeRequestOutputFormat = typeof StabilityImageGenrationUpscaleConservativeRequestOutputFormat[keyof typeof StabilityImageGenrationUpscaleConservativeRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUpscaleConservativeRequestOutputFormat = {
- jpeg: "jpeg",
- png: "png",
- webp: "webp",
+ jpeg: 'jpeg',
+ png: 'png',
+ webp: 'webp',
} as const;
export interface StabilityImageGenrationUpscaleConservativeRequest {
- creativity?: StabilityCreativity;
- /** The image you wish to upscale.
+ creativity?: StabilityCreativity;
+ /** The image you wish to upscale.
Supported Formats:
- jpeg
@@ -6530,16 +6631,16 @@ Validation Rules:
- Every side must be at least 64 pixels
- Total pixel count must be between 4,096 and 9,437,184 pixels
- The aspect ratio must be between 1:2.5 and 2.5:1 */
- image: Blob;
- /**
+ image: Blob;
+ /**
* A blurb of text describing what you **do not** wish to see in the output image.
This is an advanced feature.
* @maxLength 10000
*/
- negative_prompt?: string;
- /** Dictates the `content-type` of the generated image. */
- output_format?: StabilityImageGenrationUpscaleConservativeRequestOutputFormat;
- /**
+ negative_prompt?: string;
+ /** Dictates the `content-type` of the generated image. */
+ output_format?: StabilityImageGenrationUpscaleConservativeRequestOutputFormat;
+ /**
* What you wish to see in the output image. A strong, descriptive prompt that clearly defines
elements, colors, and subjects will lead to better results.
@@ -6550,13 +6651,13 @@ would convey a sky that was blue and green, but more green than blue.
* @minLength 1
* @maxLength 10000
*/
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
}
/**
@@ -6566,177 +6667,176 @@ would convey a sky that was blue and green, but more green than blue.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityImageGenrationUpscaleConservativeResponse200FinishReason =
- (typeof StabilityImageGenrationUpscaleConservativeResponse200FinishReason)[keyof typeof StabilityImageGenrationUpscaleConservativeResponse200FinishReason];
+export type StabilityImageGenrationUpscaleConservativeResponse200FinishReason = typeof StabilityImageGenrationUpscaleConservativeResponse200FinishReason[keyof typeof StabilityImageGenrationUpscaleConservativeResponse200FinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const StabilityImageGenrationUpscaleConservativeResponse200FinishReason =
- {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
- } as const;
+export const StabilityImageGenrationUpscaleConservativeResponse200FinishReason = {
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
+} as const;
export interface StabilityImageGenrationUpscaleConservativeResponse200 {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationUpscaleConservativeResponse200FinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityImageGenrationUpscaleConservativeResponse200FinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
}
export interface StabilityImageGenrationUpscaleConservativeResponse400 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleConservativeResponse413 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleConservativeResponse422 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleConservativeResponse429 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleConservativeResponse500 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
/**
* Dictates the `content-type` of the generated image.
*/
-export type StabilityImageGenrationUpscaleCreativeRequestOutputFormat =
- (typeof StabilityImageGenrationUpscaleCreativeRequestOutputFormat)[keyof typeof StabilityImageGenrationUpscaleCreativeRequestOutputFormat];
+export type StabilityImageGenrationUpscaleCreativeRequestOutputFormat = typeof StabilityImageGenrationUpscaleCreativeRequestOutputFormat[keyof typeof StabilityImageGenrationUpscaleCreativeRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUpscaleCreativeRequestOutputFormat = {
- jpeg: "jpeg",
- png: "png",
- webp: "webp",
+ jpeg: 'jpeg',
+ png: 'png',
+ webp: 'webp',
} as const;
/**
* Guides the image model towards a particular style.
*/
-export type StabilityImageGenrationUpscaleCreativeRequestStylePreset =
- (typeof StabilityImageGenrationUpscaleCreativeRequestStylePreset)[keyof typeof StabilityImageGenrationUpscaleCreativeRequestStylePreset];
+export type StabilityImageGenrationUpscaleCreativeRequestStylePreset = typeof StabilityImageGenrationUpscaleCreativeRequestStylePreset[keyof typeof StabilityImageGenrationUpscaleCreativeRequestStylePreset];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUpscaleCreativeRequestStylePreset = {
- enhance: "enhance",
- anime: "anime",
- photographic: "photographic",
- "digital-art": "digital-art",
- "comic-book": "comic-book",
- "fantasy-art": "fantasy-art",
- "line-art": "line-art",
- "analog-film": "analog-film",
- "neon-punk": "neon-punk",
- isometric: "isometric",
- "low-poly": "low-poly",
- origami: "origami",
- "modeling-compound": "modeling-compound",
- cinematic: "cinematic",
- "3d-model": "3d-model",
- "pixel-art": "pixel-art",
- "tile-texture": "tile-texture",
+ enhance: 'enhance',
+ anime: 'anime',
+ photographic: 'photographic',
+ 'digital-art': 'digital-art',
+ 'comic-book': 'comic-book',
+ 'fantasy-art': 'fantasy-art',
+ 'line-art': 'line-art',
+ 'analog-film': 'analog-film',
+ 'neon-punk': 'neon-punk',
+ isometric: 'isometric',
+ 'low-poly': 'low-poly',
+ origami: 'origami',
+ 'modeling-compound': 'modeling-compound',
+ cinematic: 'cinematic',
+ '3d-model': '3d-model',
+ 'pixel-art': 'pixel-art',
+ 'tile-texture': 'tile-texture',
} as const;
export interface StabilityImageGenrationUpscaleCreativeRequest {
- /**
+ /**
* Indicates how creative the model should be when upscaling an image.
Higher values will result in more details being added to the image during upscaling.
* @minimum 0.1
* @maximum 0.5
*/
- creativity?: number;
- /** The image you wish to upscale.
+ creativity?: number;
+ /** The image you wish to upscale.
Supported Formats:
- jpeg
@@ -6746,16 +6846,16 @@ Supported Formats:
Validation Rules:
- Every side must be at least 64 pixels
- Total pixel count must be between 4,096 and 1,048,576 pixels */
- image: Blob;
- /**
+ image: Blob;
+ /**
* A blurb of text describing what you **do not** wish to see in the output image.
This is an advanced feature.
* @maxLength 10000
*/
- negative_prompt?: string;
- /** Dictates the `content-type` of the generated image. */
- output_format?: StabilityImageGenrationUpscaleCreativeRequestOutputFormat;
- /**
+ negative_prompt?: string;
+ /** Dictates the `content-type` of the generated image. */
+ output_format?: StabilityImageGenrationUpscaleCreativeRequestOutputFormat;
+ /**
* What you wish to see in the output image. A strong, descriptive prompt that clearly defines
elements, colors, and subjects will lead to better results.
@@ -6766,131 +6866,131 @@ would convey a sky that was blue and green, but more green than blue.
* @minLength 1
* @maxLength 10000
*/
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /** Guides the image model towards a particular style. */
- style_preset?: StabilityImageGenrationUpscaleCreativeRequestStylePreset;
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /** Guides the image model towards a particular style. */
+ style_preset?: StabilityImageGenrationUpscaleCreativeRequestStylePreset;
}
export interface StabilityImageGenrationUpscaleCreativeResponse200 {
- id: StabilityGenerationID;
+ id: StabilityGenerationID;
}
export interface StabilityImageGenrationUpscaleCreativeResponse400 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleCreativeResponse413 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleCreativeResponse422 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleCreativeResponse429 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleCreativeResponse500 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
/**
* Dictates the `content-type` of the generated image.
*/
-export type StabilityImageGenrationUpscaleFastRequestOutputFormat =
- (typeof StabilityImageGenrationUpscaleFastRequestOutputFormat)[keyof typeof StabilityImageGenrationUpscaleFastRequestOutputFormat];
+export type StabilityImageGenrationUpscaleFastRequestOutputFormat = typeof StabilityImageGenrationUpscaleFastRequestOutputFormat[keyof typeof StabilityImageGenrationUpscaleFastRequestOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUpscaleFastRequestOutputFormat = {
- jpeg: "jpeg",
- png: "png",
- webp: "webp",
+ jpeg: 'jpeg',
+ png: 'png',
+ webp: 'webp',
} as const;
export interface StabilityImageGenrationUpscaleFastRequest {
- /** The image you wish to upscale.
+ /** The image you wish to upscale.
Supported Formats:
- jpeg
@@ -6901,9 +7001,9 @@ Validation Rules:
- Width must be between 32 and 1,536 pixels
- Height must be between 32 and 1,536 pixels
- Total pixel count must be between 1,024 and 1,048,576 pixels */
- image: Blob;
- /** Dictates the `content-type` of the generated image. */
- output_format?: StabilityImageGenrationUpscaleFastRequestOutputFormat;
+ image: Blob;
+ /** Dictates the `content-type` of the generated image. */
+ output_format?: StabilityImageGenrationUpscaleFastRequestOutputFormat;
}
/**
@@ -6913,125 +7013,125 @@ Validation Rules:
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityImageGenrationUpscaleFastResponse200FinishReason =
- (typeof StabilityImageGenrationUpscaleFastResponse200FinishReason)[keyof typeof StabilityImageGenrationUpscaleFastResponse200FinishReason];
+export type StabilityImageGenrationUpscaleFastResponse200FinishReason = typeof StabilityImageGenrationUpscaleFastResponse200FinishReason[keyof typeof StabilityImageGenrationUpscaleFastResponse200FinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUpscaleFastResponse200FinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export interface StabilityImageGenrationUpscaleFastResponse200 {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationUpscaleFastResponse200FinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityImageGenrationUpscaleFastResponse200FinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
}
export interface StabilityImageGenrationUpscaleFastResponse400 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleFastResponse413 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleFastResponse422 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleFastResponse429 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
export interface StabilityImageGenrationUpscaleFastResponse500 {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
* A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)
you file, as it will greatly assist us in diagnosing the root cause of the problem.
* @minLength 1
*/
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
}
/**
@@ -7055,205 +7155,205 @@ export type StabilityStabilityClientVersion = string;
/**
* Reason for completion
*/
-export type StableAudio25AudioResponseFinishReason =
- (typeof StableAudio25AudioResponseFinishReason)[keyof typeof StableAudio25AudioResponseFinishReason];
+export type StableAudio25AudioResponseFinishReason = typeof StableAudio25AudioResponseFinishReason[keyof typeof StableAudio25AudioResponseFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StableAudio25AudioResponseFinishReason = {
- SUCCESS: "SUCCESS",
- ERROR: "ERROR",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ ERROR: 'ERROR',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
/**
* Response from Stable Audio 2.5 audio generation
*/
export interface StableAudio25AudioResponse {
- /** Base64-encoded audio data */
- audio?: string;
- /** Reason for completion */
- finish_reason?: StableAudio25AudioResponseFinishReason;
- /** Unique identifier for the generation request */
- id?: string;
+ /** Base64-encoded audio data */
+ audio?: string;
+ /** Reason for completion */
+ finish_reason?: StableAudio25AudioResponseFinishReason;
+ /** Unique identifier for the generation request */
+ id?: string;
}
/**
* Request parameters for Stable Audio audio-to-audio transformation
*/
export interface StableAudio25AudioToAudioRequest {
- /** The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long. */
- audio: Blob;
- /**
- * How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 7 for stable-audio-2 and 1 for stable-audio-2.5.
- * @minimum 1
- * @maximum 25
- */
- cfg_scale?: number;
- /**
- * Controls the duration in seconds of the generated audio.
- * @minimum 1
- * @maximum 190
- */
- duration?: number;
- model: StableAudio25Model;
- output_format?: StableAudio25OutputFormat;
- /**
- * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
- * @maxLength 10000
- */
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /**
- * Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).
- * @minimum 4
- * @maximum 8
- */
- steps?: number;
- /**
- * Controls how much influence the audio parameter has on the generated audio. A value of 0 would yield audio that is identical to the input. A value of 1 would be as if you passed in no audio at all. Minimum value for stable-audio-2.5 is 0.01.
- * @minimum 0
- * @maximum 1
- */
- strength?: number;
+ /** The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long. */
+ audio: Blob;
+ /**
+ * How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 7 for stable-audio-2 and 1 for stable-audio-2.5.
+ * @minimum 1
+ * @maximum 25
+ */
+ cfg_scale?: number;
+ /**
+ * Controls the duration in seconds of the generated audio.
+ * @minimum 1
+ * @maximum 190
+ */
+ duration?: number;
+ model: StableAudio25Model;
+ output_format?: StableAudio25OutputFormat;
+ /**
+ * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
+ * @maxLength 10000
+ */
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /**
+ * Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).
+ * @minimum 4
+ * @maximum 8
+ */
+ steps?: number;
+ /**
+ * Controls how much influence the audio parameter has on the generated audio. A value of 0 would yield audio that is identical to the input. A value of 1 would be as if you passed in no audio at all. Minimum value for stable-audio-2.5 is 0.01.
+ * @minimum 0
+ * @maximum 1
+ */
+ strength?: number;
}
/**
* Request parameters for Stable Audio 2.5 audio inpainting
*/
export interface StableAudio25InpaintRequest {
- /** The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long. */
- audio: Blob;
- /**
- * Controls the duration in seconds of the generated audio.
- * @minimum 1
- * @maximum 190
- */
- duration?: number;
- /**
- * End time in seconds for the audio segment to be inpainted.
- * @minimum 0
- * @maximum 190
- */
- mask_end?: number;
- /**
- * Start time in seconds for the audio segment to be inpainted.
- * @minimum 0
- * @maximum 190
- */
- mask_start?: number;
- output_format?: StableAudio25OutputFormat;
- /**
- * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
- * @maxLength 10000
- */
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /**
- * Controls the number of sampling steps.
- * @minimum 4
- * @maximum 8
- */
- steps?: number;
+ /** The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long. */
+ audio: Blob;
+ /**
+ * Controls the duration in seconds of the generated audio.
+ * @minimum 1
+ * @maximum 190
+ */
+ duration?: number;
+ /**
+ * End time in seconds for the audio segment to be inpainted.
+ * @minimum 0
+ * @maximum 190
+ */
+ mask_end?: number;
+ /**
+ * Start time in seconds for the audio segment to be inpainted.
+ * @minimum 0
+ * @maximum 190
+ */
+ mask_start?: number;
+ output_format?: StableAudio25OutputFormat;
+ /**
+ * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
+ * @maxLength 10000
+ */
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /**
+ * Controls the number of sampling steps.
+ * @minimum 4
+ * @maximum 8
+ */
+ steps?: number;
}
/**
* The model to use for generation
*/
-export type StableAudio25Model =
- (typeof StableAudio25Model)[keyof typeof StableAudio25Model];
+export type StableAudio25Model = typeof StableAudio25Model[keyof typeof StableAudio25Model];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StableAudio25Model = {
- "stable-audio-25": "stable-audio-2.5",
+ 'stable-audio-25': 'stable-audio-2.5',
} as const;
/**
* Dictates the content-type of the generated audio
*/
-export type StableAudio25OutputFormat =
- (typeof StableAudio25OutputFormat)[keyof typeof StableAudio25OutputFormat];
+export type StableAudio25OutputFormat = typeof StableAudio25OutputFormat[keyof typeof StableAudio25OutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StableAudio25OutputFormat = {
- mp3: "mp3",
- wav: "wav",
+ mp3: 'mp3',
+ wav: 'wav',
} as const;
/**
* Request parameters for Stable Audio 2.5 text-to-audio generation
*/
export interface StableAudio25TextToAudioRequest {
- /**
- * How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 1 for stable-audio-2.5.
- * @minimum 1
- * @maximum 25
- */
- cfg_scale?: number;
- /**
- * Controls the duration in seconds of the generated audio.
- * @minimum 1
- * @maximum 190
- */
- duration?: number;
- model: StableAudio25Model;
- output_format?: StableAudio25OutputFormat;
- /**
- * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
- * @maxLength 10000
- */
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /**
- * Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).
- * @minimum 4
- * @maximum 8
- */
- steps?: number;
+ /**
+ * How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 1 for stable-audio-2.5.
+ * @minimum 1
+ * @maximum 25
+ */
+ cfg_scale?: number;
+ /**
+ * Controls the duration in seconds of the generated audio.
+ * @minimum 1
+ * @maximum 190
+ */
+ duration?: number;
+ model: StableAudio25Model;
+ output_format?: StableAudio25OutputFormat;
+ /**
+ * What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.
+ * @maxLength 10000
+ */
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /**
+ * Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).
+ * @minimum 4
+ * @maximum 8
+ */
+ steps?: number;
}
export interface StorageFile {
- /** Path to the file in storage */
- file_path?: string;
- /** Unique identifier for the storage file */
- id?: string;
- /** Public URL */
- public_url?: string;
+ /** Path to the file in storage */
+ file_path?: string;
+ /** Unique identifier for the storage file */
+ id?: string;
+ /** Public URL */
+ public_url?: string;
}
export interface StripeAddress {
- /** @nullable */
- city?: string | null;
- /** @nullable */
- country?: string | null;
- /** @nullable */
- line1?: string | null;
- /** @nullable */
- line2?: string | null;
- /** @nullable */
- postal_code?: string | null;
- /** @nullable */
- state?: string | null;
+ /** @nullable */
+ city?: string | null;
+ /** @nullable */
+ country?: string | null;
+ /** @nullable */
+ line1?: string | null;
+ /** @nullable */
+ line2?: string | null;
+ /** @nullable */
+ postal_code?: string | null;
+ /** @nullable */
+ state?: string | null;
}
export type StripeAmountDetailsTip = { [key: string]: unknown };
export interface StripeAmountDetails {
- tip?: StripeAmountDetailsTip;
+ tip?: StripeAmountDetailsTip;
}
/**
@@ -7262,15 +7362,15 @@ export interface StripeAmountDetails {
export type StripeBillingDetailsTaxId = unknown | null;
export interface StripeBillingDetails {
- address?: StripeAddress;
- /** @nullable */
- email?: string | null;
- /** @nullable */
- name?: string | null;
- /** @nullable */
- phone?: string | null;
- /** @nullable */
- tax_id?: StripeBillingDetailsTaxId;
+ address?: StripeAddress;
+ /** @nullable */
+ email?: string | null;
+ /** @nullable */
+ name?: string | null;
+ /** @nullable */
+ phone?: string | null;
+ /** @nullable */
+ tax_id?: StripeBillingDetailsTaxId;
}
/**
@@ -7289,19 +7389,19 @@ export type StripeCardDetailsChecksAddressLine1Check = unknown | null;
export type StripeCardDetailsChecksAddressPostalCodeCheck = unknown | null;
export type StripeCardDetailsChecks = {
- /** @nullable */
- address_line1_check?: StripeCardDetailsChecksAddressLine1Check;
- /** @nullable */
- address_postal_code_check?: StripeCardDetailsChecksAddressPostalCodeCheck;
- cvc_check?: string;
+ /** @nullable */
+ address_line1_check?: StripeCardDetailsChecksAddressLine1Check;
+ /** @nullable */
+ address_postal_code_check?: StripeCardDetailsChecksAddressPostalCodeCheck;
+ cvc_check?: string;
};
export type StripeCardDetailsExtendedAuthorization = {
- status?: string;
+ status?: string;
};
export type StripeCardDetailsIncrementalAuthorization = {
- status?: string;
+ status?: string;
};
/**
@@ -7315,16 +7415,16 @@ export type StripeCardDetailsInstallments = unknown | null;
export type StripeCardDetailsMandate = unknown | null;
export type StripeCardDetailsMulticapture = {
- status?: string;
+ status?: string;
};
export type StripeCardDetailsNetworkToken = {
- used?: boolean;
+ used?: boolean;
};
export type StripeCardDetailsOvercapture = {
- maximum_amount_capturable?: number;
- status?: string;
+ maximum_amount_capturable?: number;
+ status?: string;
};
/**
@@ -7338,33 +7438,33 @@ export type StripeCardDetailsThreeDSecure = unknown | null;
export type StripeCardDetailsWallet = unknown | null;
export interface StripeCardDetails {
- amount_authorized?: number;
- /** @nullable */
- authorization_code?: StripeCardDetailsAuthorizationCode;
- brand?: string;
- checks?: StripeCardDetailsChecks;
- country?: string;
- exp_month?: number;
- exp_year?: number;
- extended_authorization?: StripeCardDetailsExtendedAuthorization;
- fingerprint?: string;
- funding?: string;
- incremental_authorization?: StripeCardDetailsIncrementalAuthorization;
- /** @nullable */
- installments?: StripeCardDetailsInstallments;
- last4?: string;
- /** @nullable */
- mandate?: StripeCardDetailsMandate;
- multicapture?: StripeCardDetailsMulticapture;
- network?: string;
- network_token?: StripeCardDetailsNetworkToken;
- network_transaction_id?: string;
- overcapture?: StripeCardDetailsOvercapture;
- regulated_status?: string;
- /** @nullable */
- three_d_secure?: StripeCardDetailsThreeDSecure;
- /** @nullable */
- wallet?: StripeCardDetailsWallet;
+ amount_authorized?: number;
+ /** @nullable */
+ authorization_code?: StripeCardDetailsAuthorizationCode;
+ brand?: string;
+ checks?: StripeCardDetailsChecks;
+ country?: string;
+ exp_month?: number;
+ exp_year?: number;
+ extended_authorization?: StripeCardDetailsExtendedAuthorization;
+ fingerprint?: string;
+ funding?: string;
+ incremental_authorization?: StripeCardDetailsIncrementalAuthorization;
+ /** @nullable */
+ installments?: StripeCardDetailsInstallments;
+ last4?: string;
+ /** @nullable */
+ mandate?: StripeCardDetailsMandate;
+ multicapture?: StripeCardDetailsMulticapture;
+ network?: string;
+ network_token?: StripeCardDetailsNetworkToken;
+ network_transaction_id?: string;
+ overcapture?: StripeCardDetailsOvercapture;
+ regulated_status?: string;
+ /** @nullable */
+ three_d_secure?: StripeCardDetailsThreeDSecure;
+ /** @nullable */
+ wallet?: StripeCardDetailsWallet;
}
/**
@@ -7401,12 +7501,12 @@ export type StripeChargeInvoice = unknown | null;
export type StripeChargeMetadata = { [key: string]: unknown };
-export type StripeChargeObject =
- (typeof StripeChargeObject)[keyof typeof StripeChargeObject];
+export type StripeChargeObject = typeof StripeChargeObject[keyof typeof StripeChargeObject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StripeChargeObject = {
- charge: "charge",
+ charge: 'charge',
} as const;
/**
@@ -7457,117 +7557,117 @@ export type StripeChargeTransferData = unknown | null;
export type StripeChargeTransferGroup = unknown | null;
export interface StripeCharge {
- amount?: number;
- amount_captured?: number;
- amount_refunded?: number;
- /** @nullable */
- application?: string | null;
- /** @nullable */
- application_fee?: string | null;
- /** @nullable */
- application_fee_amount?: number | null;
- /** @nullable */
- balance_transaction?: string | null;
- billing_details?: StripeBillingDetails;
- calculated_statement_descriptor?: string;
- captured?: boolean;
- created?: number;
- currency?: string;
- /** @nullable */
- customer?: string | null;
- /** @nullable */
- description?: string | null;
- /** @nullable */
- destination?: StripeChargeDestination;
- /** @nullable */
- dispute?: StripeChargeDispute;
- disputed?: boolean;
- /** @nullable */
- failure_balance_transaction?: StripeChargeFailureBalanceTransaction;
- /** @nullable */
- failure_code?: StripeChargeFailureCode;
- /** @nullable */
- failure_message?: StripeChargeFailureMessage;
- fraud_details?: StripeChargeFraudDetails;
- id?: string;
- /** @nullable */
- invoice?: StripeChargeInvoice;
- livemode?: boolean;
- metadata?: StripeChargeMetadata;
- object?: StripeChargeObject;
- /** @nullable */
- on_behalf_of?: StripeChargeOnBehalfOf;
- /** @nullable */
- order?: StripeChargeOrder;
- outcome?: StripeOutcome;
- paid?: boolean;
- payment_intent?: string;
- payment_method?: string;
- payment_method_details?: StripePaymentMethodDetails;
- radar_options?: StripeChargeRadarOptions;
- /** @nullable */
- receipt_email?: string | null;
- /** @nullable */
- receipt_number?: string | null;
- receipt_url?: string;
- refunded?: boolean;
- refunds?: StripeRefundList;
- /** @nullable */
- review?: StripeChargeReview;
- shipping?: StripeShipping;
- /** @nullable */
- source?: StripeChargeSource;
- /** @nullable */
- source_transfer?: StripeChargeSourceTransfer;
- /** @nullable */
- statement_descriptor?: StripeChargeStatementDescriptor;
- /** @nullable */
- statement_descriptor_suffix?: StripeChargeStatementDescriptorSuffix;
- status?: string;
- /** @nullable */
- transfer_data?: StripeChargeTransferData;
- /** @nullable */
- transfer_group?: StripeChargeTransferGroup;
+ amount?: number;
+ amount_captured?: number;
+ amount_refunded?: number;
+ /** @nullable */
+ application?: string | null;
+ /** @nullable */
+ application_fee?: string | null;
+ /** @nullable */
+ application_fee_amount?: number | null;
+ /** @nullable */
+ balance_transaction?: string | null;
+ billing_details?: StripeBillingDetails;
+ calculated_statement_descriptor?: string;
+ captured?: boolean;
+ created?: number;
+ currency?: string;
+ /** @nullable */
+ customer?: string | null;
+ /** @nullable */
+ description?: string | null;
+ /** @nullable */
+ destination?: StripeChargeDestination;
+ /** @nullable */
+ dispute?: StripeChargeDispute;
+ disputed?: boolean;
+ /** @nullable */
+ failure_balance_transaction?: StripeChargeFailureBalanceTransaction;
+ /** @nullable */
+ failure_code?: StripeChargeFailureCode;
+ /** @nullable */
+ failure_message?: StripeChargeFailureMessage;
+ fraud_details?: StripeChargeFraudDetails;
+ id?: string;
+ /** @nullable */
+ invoice?: StripeChargeInvoice;
+ livemode?: boolean;
+ metadata?: StripeChargeMetadata;
+ object?: StripeChargeObject;
+ /** @nullable */
+ on_behalf_of?: StripeChargeOnBehalfOf;
+ /** @nullable */
+ order?: StripeChargeOrder;
+ outcome?: StripeOutcome;
+ paid?: boolean;
+ payment_intent?: string;
+ payment_method?: string;
+ payment_method_details?: StripePaymentMethodDetails;
+ radar_options?: StripeChargeRadarOptions;
+ /** @nullable */
+ receipt_email?: string | null;
+ /** @nullable */
+ receipt_number?: string | null;
+ receipt_url?: string;
+ refunded?: boolean;
+ refunds?: StripeRefundList;
+ /** @nullable */
+ review?: StripeChargeReview;
+ shipping?: StripeShipping;
+ /** @nullable */
+ source?: StripeChargeSource;
+ /** @nullable */
+ source_transfer?: StripeChargeSourceTransfer;
+ /** @nullable */
+ statement_descriptor?: StripeChargeStatementDescriptor;
+ /** @nullable */
+ statement_descriptor_suffix?: StripeChargeStatementDescriptorSuffix;
+ status?: string;
+ /** @nullable */
+ transfer_data?: StripeChargeTransferData;
+ /** @nullable */
+ transfer_group?: StripeChargeTransferGroup;
}
export interface StripeChargeList {
- data?: StripeCharge[];
- has_more?: boolean;
- object?: string;
- total_count?: number;
- url?: string;
+ data?: StripeCharge[];
+ has_more?: boolean;
+ object?: string;
+ total_count?: number;
+ url?: string;
}
export type StripeEventData = {
- object?: StripePaymentIntent;
+ object?: StripePaymentIntent;
};
-export type StripeEventObject =
- (typeof StripeEventObject)[keyof typeof StripeEventObject];
+export type StripeEventObject = typeof StripeEventObject[keyof typeof StripeEventObject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StripeEventObject = {
- event: "event",
+ event: 'event',
} as const;
-export type StripeEventType =
- (typeof StripeEventType)[keyof typeof StripeEventType];
+export type StripeEventType = typeof StripeEventType[keyof typeof StripeEventType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StripeEventType = {
- payment_intentsucceeded: "payment_intent.succeeded",
+ payment_intentsucceeded: 'payment_intent.succeeded',
} as const;
export interface StripeEvent {
- api_version?: string;
- created?: number;
- data: StripeEventData;
- id: string;
- livemode?: boolean;
- object: StripeEventObject;
- pending_webhooks?: number;
- request?: StripeRequestInfo;
- type: StripeEventType;
+ api_version?: string;
+ created?: number;
+ data: StripeEventData;
+ id: string;
+ livemode?: boolean;
+ object: StripeEventObject;
+ pending_webhooks?: number;
+ request?: StripeRequestInfo;
+ type: StripeEventType;
}
/**
@@ -7591,19 +7691,19 @@ export type StripeOutcomeNetworkDeclineCode = unknown | null;
export type StripeOutcomeReason = unknown | null;
export interface StripeOutcome {
- /** @nullable */
- advice_code?: StripeOutcomeAdviceCode;
- /** @nullable */
- network_advice_code?: StripeOutcomeNetworkAdviceCode;
- /** @nullable */
- network_decline_code?: StripeOutcomeNetworkDeclineCode;
- network_status?: string;
- /** @nullable */
- reason?: StripeOutcomeReason;
- risk_level?: string;
- risk_score?: number;
- seller_message?: string;
- type?: string;
+ /** @nullable */
+ advice_code?: StripeOutcomeAdviceCode;
+ /** @nullable */
+ network_advice_code?: StripeOutcomeNetworkAdviceCode;
+ /** @nullable */
+ network_decline_code?: StripeOutcomeNetworkDeclineCode;
+ network_status?: string;
+ /** @nullable */
+ reason?: StripeOutcomeReason;
+ risk_level?: string;
+ risk_score?: number;
+ seller_message?: string;
+ type?: string;
}
/**
@@ -7623,12 +7723,12 @@ export type StripePaymentIntentMetadata = { [key: string]: unknown };
*/
export type StripePaymentIntentNextAction = unknown | null;
-export type StripePaymentIntentObject =
- (typeof StripePaymentIntentObject)[keyof typeof StripePaymentIntentObject];
+export type StripePaymentIntentObject = typeof StripePaymentIntentObject[keyof typeof StripePaymentIntentObject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StripePaymentIntentObject = {
- payment_intent: "payment_intent",
+ payment_intent: 'payment_intent',
} as const;
/**
@@ -7639,9 +7739,7 @@ export type StripePaymentIntentOnBehalfOf = unknown | null;
/**
* @nullable
*/
-export type StripePaymentIntentPaymentMethodConfigurationDetails =
- | unknown
- | null;
+export type StripePaymentIntentPaymentMethodConfigurationDetails = unknown | null;
/**
* @nullable
@@ -7684,73 +7782,73 @@ export type StripePaymentIntentTransferData = unknown | null;
export type StripePaymentIntentTransferGroup = unknown | null;
export interface StripePaymentIntent {
- amount?: number;
- amount_capturable?: number;
- amount_details?: StripeAmountDetails;
- amount_received?: number;
- /** @nullable */
- application?: string | null;
- /** @nullable */
- application_fee_amount?: number | null;
- /** @nullable */
- automatic_payment_methods?: StripePaymentIntentAutomaticPaymentMethods;
- /** @nullable */
- canceled_at?: number | null;
- /** @nullable */
- cancellation_reason?: string | null;
- capture_method?: string;
- charges?: StripeChargeList;
- client_secret?: string;
- confirmation_method?: string;
- created?: number;
- currency?: string;
- /** @nullable */
- customer?: string | null;
- /** @nullable */
- description?: string | null;
- id?: string;
- /** @nullable */
- invoice?: string | null;
- /** @nullable */
- last_payment_error?: StripePaymentIntentLastPaymentError;
- latest_charge?: string;
- livemode?: boolean;
- metadata?: StripePaymentIntentMetadata;
- /** @nullable */
- next_action?: StripePaymentIntentNextAction;
- object?: StripePaymentIntentObject;
- /** @nullable */
- on_behalf_of?: StripePaymentIntentOnBehalfOf;
- payment_method?: string;
- /** @nullable */
- payment_method_configuration_details?: StripePaymentIntentPaymentMethodConfigurationDetails;
- payment_method_options?: StripePaymentMethodOptions;
- payment_method_types?: string[];
- /** @nullable */
- processing?: StripePaymentIntentProcessing;
- /** @nullable */
- receipt_email?: string | null;
- /** @nullable */
- review?: StripePaymentIntentReview;
- /** @nullable */
- setup_future_usage?: StripePaymentIntentSetupFutureUsage;
- shipping?: StripeShipping;
- /** @nullable */
- source?: StripePaymentIntentSource;
- /** @nullable */
- statement_descriptor?: StripePaymentIntentStatementDescriptor;
- /** @nullable */
- statement_descriptor_suffix?: StripePaymentIntentStatementDescriptorSuffix;
- status?: string;
- /** @nullable */
- transfer_data?: StripePaymentIntentTransferData;
- /** @nullable */
- transfer_group?: StripePaymentIntentTransferGroup;
+ amount?: number;
+ amount_capturable?: number;
+ amount_details?: StripeAmountDetails;
+ amount_received?: number;
+ /** @nullable */
+ application?: string | null;
+ /** @nullable */
+ application_fee_amount?: number | null;
+ /** @nullable */
+ automatic_payment_methods?: StripePaymentIntentAutomaticPaymentMethods;
+ /** @nullable */
+ canceled_at?: number | null;
+ /** @nullable */
+ cancellation_reason?: string | null;
+ capture_method?: string;
+ charges?: StripeChargeList;
+ client_secret?: string;
+ confirmation_method?: string;
+ created?: number;
+ currency?: string;
+ /** @nullable */
+ customer?: string | null;
+ /** @nullable */
+ description?: string | null;
+ id?: string;
+ /** @nullable */
+ invoice?: string | null;
+ /** @nullable */
+ last_payment_error?: StripePaymentIntentLastPaymentError;
+ latest_charge?: string;
+ livemode?: boolean;
+ metadata?: StripePaymentIntentMetadata;
+ /** @nullable */
+ next_action?: StripePaymentIntentNextAction;
+ object?: StripePaymentIntentObject;
+ /** @nullable */
+ on_behalf_of?: StripePaymentIntentOnBehalfOf;
+ payment_method?: string;
+ /** @nullable */
+ payment_method_configuration_details?: StripePaymentIntentPaymentMethodConfigurationDetails;
+ payment_method_options?: StripePaymentMethodOptions;
+ payment_method_types?: string[];
+ /** @nullable */
+ processing?: StripePaymentIntentProcessing;
+ /** @nullable */
+ receipt_email?: string | null;
+ /** @nullable */
+ review?: StripePaymentIntentReview;
+ /** @nullable */
+ setup_future_usage?: StripePaymentIntentSetupFutureUsage;
+ shipping?: StripeShipping;
+ /** @nullable */
+ source?: StripePaymentIntentSource;
+ /** @nullable */
+ statement_descriptor?: StripePaymentIntentStatementDescriptor;
+ /** @nullable */
+ statement_descriptor_suffix?: StripePaymentIntentStatementDescriptorSuffix;
+ status?: string;
+ /** @nullable */
+ transfer_data?: StripePaymentIntentTransferData;
+ /** @nullable */
+ transfer_group?: StripePaymentIntentTransferGroup;
}
export interface StripePaymentMethodDetails {
- card?: StripeCardDetails;
- type?: string;
+ card?: StripeCardDetails;
+ type?: string;
}
/**
@@ -7769,45 +7867,45 @@ export type StripePaymentMethodOptionsCardMandateOptions = unknown | null;
export type StripePaymentMethodOptionsCardNetwork = unknown | null;
export type StripePaymentMethodOptionsCard = {
- /** @nullable */
- installments?: StripePaymentMethodOptionsCardInstallments;
- /** @nullable */
- mandate_options?: StripePaymentMethodOptionsCardMandateOptions;
- /** @nullable */
- network?: StripePaymentMethodOptionsCardNetwork;
- request_three_d_secure?: string;
+ /** @nullable */
+ installments?: StripePaymentMethodOptionsCardInstallments;
+ /** @nullable */
+ mandate_options?: StripePaymentMethodOptionsCardMandateOptions;
+ /** @nullable */
+ network?: StripePaymentMethodOptionsCardNetwork;
+ request_three_d_secure?: string;
};
export interface StripePaymentMethodOptions {
- card?: StripePaymentMethodOptionsCard;
+ card?: StripePaymentMethodOptionsCard;
}
export type StripeRefundListDataItem = { [key: string]: unknown };
export interface StripeRefundList {
- data?: StripeRefundListDataItem[];
- has_more?: boolean;
- object?: string;
- total_count?: number;
- url?: string;
+ data?: StripeRefundListDataItem[];
+ has_more?: boolean;
+ object?: string;
+ total_count?: number;
+ url?: string;
}
export interface StripeRequestInfo {
- /** @nullable */
- id?: string | null;
- /** @nullable */
- idempotency_key?: string | null;
+ /** @nullable */
+ id?: string | null;
+ /** @nullable */
+ idempotency_key?: string | null;
}
export interface StripeShipping {
- address?: StripeAddress;
- /** @nullable */
- carrier?: string | null;
- name?: string;
- /** @nullable */
- phone?: string | null;
- /** @nullable */
- tracking_number?: string | null;
+ address?: StripeAddress;
+ /** @nullable */
+ carrier?: string | null;
+ name?: string;
+ /** @nullable */
+ phone?: string | null;
+ /** @nullable */
+ tracking_number?: string | null;
}
/**
@@ -7826,20 +7924,17 @@ ensures the message the model generates is valid JSON. Using `json_schema`
is preferred for models that support it.
*/
-export type TextResponseFormatConfiguration =
- | ResponseFormatText
- | TextResponseFormatJsonSchema
- | ResponseFormatJsonObject;
+export type TextResponseFormatConfiguration = ResponseFormatText | TextResponseFormatJsonSchema | ResponseFormatJsonObject;
/**
* The type of response format being defined. Always `json_schema`.
*/
-export type TextResponseFormatJsonSchemaType =
- (typeof TextResponseFormatJsonSchemaType)[keyof typeof TextResponseFormatJsonSchemaType];
+export type TextResponseFormatJsonSchemaType = typeof TextResponseFormatJsonSchemaType[keyof typeof TextResponseFormatJsonSchemaType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TextResponseFormatJsonSchemaType = {
- json_schema: "json_schema",
+ json_schema: 'json_schema',
} as const;
/**
@@ -7848,41 +7943,37 @@ Learn more about [Structured Outputs](/docs/guides/structured-outputs).
*/
export interface TextResponseFormatJsonSchema {
- /** A description of what the response format is for, used by the model to
+ /** A description of what the response format is for, used by the model to
determine how to respond in the format.
*/
- description?: string;
- /** The name of the response format. Must be a-z, A-Z, 0-9, or contain
+ description?: string;
+ /** The name of the response format. Must be a-z, A-Z, 0-9, or contain
underscores and dashes, with a maximum length of 64.
*/
- name: string;
- schema: ResponseFormatJsonSchemaSchema;
- /** Whether to enable strict schema adherence when generating the output.
+ name: string;
+ schema: ResponseFormatJsonSchemaSchema;
+ /** Whether to enable strict schema adherence when generating the output.
If set to true, the model will always follow the exact schema defined
in the `schema` field. Only a subset of JSON Schema is supported when
`strict` is `true`. To learn more, read the [Structured Outputs
guide](/docs/guides/structured-outputs).
*/
- strict?: boolean;
- /** The type of response format being defined. Always `json_schema`. */
- type: TextResponseFormatJsonSchemaType;
+ strict?: boolean;
+ /** The type of response format being defined. Always `json_schema`. */
+ type: TextResponseFormatJsonSchemaType;
}
-export type Tool =
- | FileSearchTool
- | FunctionTool
- | WebSearchPreviewTool
- | ComputerUsePreviewTool;
+export type Tool = FileSearchTool | FunctionTool | WebSearchPreviewTool | ComputerUsePreviewTool;
/**
* For function calling, the type is always `function`.
*/
-export type ToolChoiceFunctionType =
- (typeof ToolChoiceFunctionType)[keyof typeof ToolChoiceFunctionType];
+export type ToolChoiceFunctionType = typeof ToolChoiceFunctionType[keyof typeof ToolChoiceFunctionType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ToolChoiceFunctionType = {
- function: "function",
+ function: 'function',
} as const;
/**
@@ -7890,10 +7981,10 @@ export const ToolChoiceFunctionType = {
*/
export interface ToolChoiceFunction {
- /** The name of the function to call. */
- name: string;
- /** For function calling, the type is always `function`. */
- type: ToolChoiceFunctionType;
+ /** The name of the function to call. */
+ name: string;
+ /** For function calling, the type is always `function`. */
+ type: ToolChoiceFunctionType;
}
/**
@@ -7907,14 +7998,14 @@ more tools.
`required` means the model must call one or more tools.
*/
-export type ToolChoiceOptions =
- (typeof ToolChoiceOptions)[keyof typeof ToolChoiceOptions];
+export type ToolChoiceOptions = typeof ToolChoiceOptions[keyof typeof ToolChoiceOptions];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ToolChoiceOptions = {
- none: "none",
- auto: "auto",
- required: "required",
+ none: 'none',
+ auto: 'auto',
+ required: 'required',
} as const;
/**
@@ -7927,15 +8018,15 @@ Allowed values are:
- `computer_use_preview`
*/
-export type ToolChoiceTypesType =
- (typeof ToolChoiceTypesType)[keyof typeof ToolChoiceTypesType];
+export type ToolChoiceTypesType = typeof ToolChoiceTypesType[keyof typeof ToolChoiceTypesType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ToolChoiceTypesType = {
- file_search: "file_search",
- web_search_preview: "web_search_preview",
- computer_use_preview: "computer_use_preview",
- web_search_preview_2025_03_11: "web_search_preview_2025_03_11",
+ file_search: 'file_search',
+ web_search_preview: 'web_search_preview',
+ computer_use_preview: 'computer_use_preview',
+ web_search_preview_2025_03_11: 'web_search_preview_2025_03_11',
} as const;
/**
@@ -7944,7 +8035,7 @@ export const ToolChoiceTypesType = {
*/
export interface ToolChoiceTypes {
- /** The type of hosted tool the model should to use. Learn more about
+ /** The type of hosted tool the model should to use. Learn more about
[built-in tools](/docs/guides/tools).
Allowed values are:
@@ -7952,139 +8043,139 @@ Allowed values are:
- `web_search_preview`
- `computer_use_preview`
*/
- type: ToolChoiceTypesType;
+ type: ToolChoiceTypesType;
}
-export type TripoAnimation =
- (typeof TripoAnimation)[keyof typeof TripoAnimation];
+export type TripoAnimation = typeof TripoAnimation[keyof typeof TripoAnimation];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoAnimation = {
- "preset:idle": "preset:idle",
- "preset:walk": "preset:walk",
- "preset:climb": "preset:climb",
- "preset:jump": "preset:jump",
- "preset:run": "preset:run",
- "preset:slash": "preset:slash",
- "preset:shoot": "preset:shoot",
- "preset:hurt": "preset:hurt",
- "preset:fall": "preset:fall",
- "preset:turn": "preset:turn",
+ 'preset:idle': 'preset:idle',
+ 'preset:walk': 'preset:walk',
+ 'preset:climb': 'preset:climb',
+ 'preset:jump': 'preset:jump',
+ 'preset:run': 'preset:run',
+ 'preset:slash': 'preset:slash',
+ 'preset:shoot': 'preset:shoot',
+ 'preset:hurt': 'preset:hurt',
+ 'preset:fall': 'preset:fall',
+ 'preset:turn': 'preset:turn',
} as const;
export interface TripoBalance {
- balance: number;
- frozen: number;
+ balance: number;
+ frozen: number;
}
-export type TripoConvertFormat =
- (typeof TripoConvertFormat)[keyof typeof TripoConvertFormat];
+export type TripoConvertFormat = typeof TripoConvertFormat[keyof typeof TripoConvertFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoConvertFormat = {
- GLTF: "GLTF",
- USDZ: "USDZ",
- FBX: "FBX",
- OBJ: "OBJ",
- STL: "STL",
- "3MF": "3MF",
+ GLTF: 'GLTF',
+ USDZ: 'USDZ',
+ FBX: 'FBX',
+ OBJ: 'OBJ',
+ STL: 'STL',
+ '3MF': '3MF',
} as const;
-export type TripoErrorResponseCode =
- (typeof TripoErrorResponseCode)[keyof typeof TripoErrorResponseCode];
+export type TripoErrorResponseCode = typeof TripoErrorResponseCode[keyof typeof TripoErrorResponseCode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoErrorResponseCode = {
- NUMBER_1001: 1001,
- NUMBER_2000: 2000,
- NUMBER_2001: 2001,
- NUMBER_2002: 2002,
- NUMBER_2003: 2003,
- NUMBER_2004: 2004,
- NUMBER_2006: 2006,
- NUMBER_2007: 2007,
- NUMBER_2008: 2008,
- NUMBER_2010: 2010,
+ NUMBER_1001: 1001,
+ NUMBER_2000: 2000,
+ NUMBER_2001: 2001,
+ NUMBER_2002: 2002,
+ NUMBER_2003: 2003,
+ NUMBER_2004: 2004,
+ NUMBER_2006: 2006,
+ NUMBER_2007: 2007,
+ NUMBER_2008: 2008,
+ NUMBER_2010: 2010,
} as const;
export interface TripoErrorResponse {
- code: TripoErrorResponseCode;
- message: string;
- suggestion: string;
+ code: TripoErrorResponseCode;
+ message: string;
+ suggestion: string;
}
/**
* Task type for Tripo image-to-model generation.
*/
-export type TripoImageToModel =
- (typeof TripoImageToModel)[keyof typeof TripoImageToModel];
+export type TripoImageToModel = typeof TripoImageToModel[keyof typeof TripoImageToModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoImageToModel = {
- image_to_model: "image_to_model",
+ image_to_model: 'image_to_model',
} as const;
/**
* Style for the Tripo model generation.
*/
-export type TripoModelStyle =
- (typeof TripoModelStyle)[keyof typeof TripoModelStyle];
+export type TripoModelStyle = typeof TripoModelStyle[keyof typeof TripoModelStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoModelStyle = {
- "person:person2cartoon": "person:person2cartoon",
- "animal:venom": "animal:venom",
- "object:clay": "object:clay",
- "object:steampunk": "object:steampunk",
- "object:christmas": "object:christmas",
- "object:barbie": "object:barbie",
- gold: "gold",
- ancient_bronze: "ancient_bronze",
+ 'person:person2cartoon': 'person:person2cartoon',
+ 'animal:venom': 'animal:venom',
+ 'object:clay': 'object:clay',
+ 'object:steampunk': 'object:steampunk',
+ 'object:christmas': 'object:christmas',
+ 'object:barbie': 'object:barbie',
+ gold: 'gold',
+ ancient_bronze: 'ancient_bronze',
} as const;
/**
* Version of the Tripo model.
*/
-export type TripoModelVersion =
- (typeof TripoModelVersion)[keyof typeof TripoModelVersion];
+export type TripoModelVersion = typeof TripoModelVersion[keyof typeof TripoModelVersion];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoModelVersion = {
- "v25-20250123": "v2.5-20250123",
- "v20-20240919": "v2.0-20240919",
- "v14-20240625": "v1.4-20240625",
+ 'v25-20250123': 'v2.5-20250123',
+ 'v20-20240919': 'v2.0-20240919',
+ 'v14-20240625': 'v1.4-20240625',
} as const;
/**
* Mode for multiview generation, specifying view orientation.
*/
-export type TripoMultiviewMode =
- (typeof TripoMultiviewMode)[keyof typeof TripoMultiviewMode];
+export type TripoMultiviewMode = typeof TripoMultiviewMode[keyof typeof TripoMultiviewMode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoMultiviewMode = {
- LEFT: "LEFT",
- RIGHT: "RIGHT",
+ LEFT: 'LEFT',
+ RIGHT: 'RIGHT',
} as const;
/**
* Task type for Tripo multiview-to-model generation.
*/
-export type TripoMultiviewToModel =
- (typeof TripoMultiviewToModel)[keyof typeof TripoMultiviewToModel];
+export type TripoMultiviewToModel = typeof TripoMultiviewToModel[keyof typeof TripoMultiviewToModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoMultiviewToModel = {
- multiview_to_model: "multiview_to_model",
+ multiview_to_model: 'multiview_to_model',
} as const;
-export type TripoOrientation =
- (typeof TripoOrientation)[keyof typeof TripoOrientation];
+export type TripoOrientation = typeof TripoOrientation[keyof typeof TripoOrientation];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoOrientation = {
- align_image: "align_image",
- default: "default",
+ align_image: 'align_image',
+ default: 'default',
} as const;
/**
@@ -8092,985 +8183,984 @@ export const TripoOrientation = {
*/
export type TripoResponseSuccessCode = number;
-export type TripoSpec = (typeof TripoSpec)[keyof typeof TripoSpec];
+export type TripoSpec = typeof TripoSpec[keyof typeof TripoSpec];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoSpec = {
- mixamo: "mixamo",
- tripo: "tripo",
+ mixamo: 'mixamo',
+ tripo: 'tripo',
} as const;
-export type TripoStandardFormat =
- (typeof TripoStandardFormat)[keyof typeof TripoStandardFormat];
+export type TripoStandardFormat = typeof TripoStandardFormat[keyof typeof TripoStandardFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoStandardFormat = {
- glb: "glb",
- fbx: "fbx",
+ glb: 'glb',
+ fbx: 'fbx',
} as const;
-export type TripoStylizeOptions =
- (typeof TripoStylizeOptions)[keyof typeof TripoStylizeOptions];
+export type TripoStylizeOptions = typeof TripoStylizeOptions[keyof typeof TripoStylizeOptions];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoStylizeOptions = {
- lego: "lego",
- voxel: "voxel",
- voronoi: "voronoi",
- minecraft: "minecraft",
+ lego: 'lego',
+ voxel: 'voxel',
+ voronoi: 'voronoi',
+ minecraft: 'minecraft',
} as const;
-export type TripoSuccessTaskCode =
- (typeof TripoSuccessTaskCode)[keyof typeof TripoSuccessTaskCode];
+export type TripoSuccessTaskCode = typeof TripoSuccessTaskCode[keyof typeof TripoSuccessTaskCode];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoSuccessTaskCode = {
- NUMBER_0: 0,
+ NUMBER_0: 0,
} as const;
export type TripoSuccessTaskData = {
- /** used for getTask */
- task_id: string;
+ /** used for getTask */
+ task_id: string;
};
export interface TripoSuccessTask {
- code: TripoSuccessTaskCode;
- data: TripoSuccessTaskData;
+ code: TripoSuccessTaskCode;
+ data: TripoSuccessTaskData;
}
export type TripoTaskInput = { [key: string]: unknown };
-export type TripoTaskOutputTopology =
- (typeof TripoTaskOutputTopology)[keyof typeof TripoTaskOutputTopology];
+export type TripoTaskOutputTopology = typeof TripoTaskOutputTopology[keyof typeof TripoTaskOutputTopology];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTaskOutputTopology = {
- bip: "bip",
- quad: "quad",
+ bip: 'bip',
+ quad: 'quad',
} as const;
export type TripoTaskOutput = {
- base_model?: string;
- model?: string;
- pbr_model?: string;
- rendered_image?: string;
- riggable?: boolean;
- topology?: TripoTaskOutputTopology;
+ base_model?: string;
+ model?: string;
+ pbr_model?: string;
+ rendered_image?: string;
+ riggable?: boolean;
+ topology?: TripoTaskOutputTopology;
};
-export type TripoTaskStatus =
- (typeof TripoTaskStatus)[keyof typeof TripoTaskStatus];
+export type TripoTaskStatus = typeof TripoTaskStatus[keyof typeof TripoTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTaskStatus = {
- queued: "queued",
- running: "running",
- success: "success",
- failed: "failed",
- cancelled: "cancelled",
- unknown: "unknown",
- banned: "banned",
- expired: "expired",
+ queued: 'queued',
+ running: 'running',
+ success: 'success',
+ failed: 'failed',
+ cancelled: 'cancelled',
+ unknown: 'unknown',
+ banned: 'banned',
+ expired: 'expired',
} as const;
export interface TripoTask {
- create_time: number;
- input: TripoTaskInput;
- output: TripoTaskOutput;
- /**
- * @minimum 0
- * @maximum 100
- */
- progress: number;
- status: TripoTaskStatus;
- task_id: string;
- type: string;
+ create_time: number;
+ input: TripoTaskInput;
+ output: TripoTaskOutput;
+ /**
+ * @minimum 0
+ * @maximum 100
+ */
+ progress: number;
+ status: TripoTaskStatus;
+ task_id: string;
+ type: string;
}
/**
* The type of the Tripo task, specifically for text-to-model operations.
*/
-export type TripoTextToModel =
- (typeof TripoTextToModel)[keyof typeof TripoTextToModel];
+export type TripoTextToModel = typeof TripoTextToModel[keyof typeof TripoTextToModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTextToModel = {
- text_to_model: "text_to_model",
+ text_to_model: 'text_to_model',
} as const;
-export type TripoTextureAlignment =
- (typeof TripoTextureAlignment)[keyof typeof TripoTextureAlignment];
+export type TripoTextureAlignment = typeof TripoTextureAlignment[keyof typeof TripoTextureAlignment];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTextureAlignment = {
- original_image: "original_image",
- geometry: "geometry",
+ original_image: 'original_image',
+ geometry: 'geometry',
} as const;
-export type TripoTextureFormat =
- (typeof TripoTextureFormat)[keyof typeof TripoTextureFormat];
+export type TripoTextureFormat = typeof TripoTextureFormat[keyof typeof TripoTextureFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTextureFormat = {
- BMP: "BMP",
- DPX: "DPX",
- HDR: "HDR",
- JPEG: "JPEG",
- OPEN_EXR: "OPEN_EXR",
- PNG: "PNG",
- TARGA: "TARGA",
- TIFF: "TIFF",
- WEBP: "WEBP",
+ BMP: 'BMP',
+ DPX: 'DPX',
+ HDR: 'HDR',
+ JPEG: 'JPEG',
+ OPEN_EXR: 'OPEN_EXR',
+ PNG: 'PNG',
+ TARGA: 'TARGA',
+ TIFF: 'TIFF',
+ WEBP: 'WEBP',
} as const;
-export type TripoTextureQuality =
- (typeof TripoTextureQuality)[keyof typeof TripoTextureQuality];
+export type TripoTextureQuality = typeof TripoTextureQuality[keyof typeof TripoTextureQuality];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTextureQuality = {
- standard: "standard",
- detailed: "detailed",
+ standard: 'standard',
+ detailed: 'detailed',
} as const;
-export type TripoTopology = (typeof TripoTopology)[keyof typeof TripoTopology];
+export type TripoTopology = typeof TripoTopology[keyof typeof TripoTopology];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTopology = {
- bip: "bip",
- quad: "quad",
+ bip: 'bip',
+ quad: 'quad',
} as const;
-export type TripoTypeAnimatePrerigcheck =
- (typeof TripoTypeAnimatePrerigcheck)[keyof typeof TripoTypeAnimatePrerigcheck];
+export type TripoTypeAnimatePrerigcheck = typeof TripoTypeAnimatePrerigcheck[keyof typeof TripoTypeAnimatePrerigcheck];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeAnimatePrerigcheck = {
- animate_prerigcheck: "animate_prerigcheck",
+ animate_prerigcheck: 'animate_prerigcheck',
} as const;
-export type TripoTypeAnimateRetarget =
- (typeof TripoTypeAnimateRetarget)[keyof typeof TripoTypeAnimateRetarget];
+export type TripoTypeAnimateRetarget = typeof TripoTypeAnimateRetarget[keyof typeof TripoTypeAnimateRetarget];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeAnimateRetarget = {
- animate_retarget: "animate_retarget",
+ animate_retarget: 'animate_retarget',
} as const;
-export type TripoTypeAnimateRig =
- (typeof TripoTypeAnimateRig)[keyof typeof TripoTypeAnimateRig];
+export type TripoTypeAnimateRig = typeof TripoTypeAnimateRig[keyof typeof TripoTypeAnimateRig];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeAnimateRig = {
- animate_rig: "animate_rig",
+ animate_rig: 'animate_rig',
} as const;
-export type TripoTypeConvertModel =
- (typeof TripoTypeConvertModel)[keyof typeof TripoTypeConvertModel];
+export type TripoTypeConvertModel = typeof TripoTypeConvertModel[keyof typeof TripoTypeConvertModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeConvertModel = {
- convert_model: "convert_model",
+ convert_model: 'convert_model',
} as const;
-export type TripoTypeRefineModel =
- (typeof TripoTypeRefineModel)[keyof typeof TripoTypeRefineModel];
+export type TripoTypeRefineModel = typeof TripoTypeRefineModel[keyof typeof TripoTypeRefineModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeRefineModel = {
- refine_model: "refine_model",
+ refine_model: 'refine_model',
} as const;
-export type TripoTypeStylizeModel =
- (typeof TripoTypeStylizeModel)[keyof typeof TripoTypeStylizeModel];
+export type TripoTypeStylizeModel = typeof TripoTypeStylizeModel[keyof typeof TripoTypeStylizeModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeStylizeModel = {
- stylize_model: "stylize_model",
+ stylize_model: 'stylize_model',
} as const;
-export type TripoTypeTextureModel =
- (typeof TripoTypeTextureModel)[keyof typeof TripoTypeTextureModel];
+export type TripoTypeTextureModel = typeof TripoTypeTextureModel[keyof typeof TripoTypeTextureModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const TripoTypeTextureModel = {
- texture_model: "texture_model",
+ texture_model: 'texture_model',
} as const;
export interface User {
- /** The email address for this user. */
- email?: string;
- /** The unique id for this user. */
- id?: string;
- /** Indicates if the user has admin privileges. */
- isAdmin?: boolean;
- /** Indicates if the user is approved. */
- isApproved?: boolean;
- /** The name for this user. */
- name?: string;
+ /** The email address for this user. */
+ email?: string;
+ /** The unique id for this user. */
+ id?: string;
+ /** Indicates if the user has admin privileges. */
+ isAdmin?: boolean;
+ /** Indicates if the user is approved. */
+ isApproved?: boolean;
+ /** The name for this user. */
+ name?: string;
}
export interface Veo2GenVidPollRequest {
- /** Full operation name (from predict response) */
- operationName: string;
+ /** Full operation name (from predict response) */
+ operationName: string;
}
/**
* Error details if operation failed
*/
export type Veo2GenVidPollResponseError = {
- /** Error code */
- code?: number;
- /** Error message */
- message?: string;
+ /** Error code */
+ code?: number;
+ /** Error message */
+ message?: string;
};
export type Veo2GenVidPollResponseResponseVideosItem = {
- /** Base64-encoded video content */
- bytesBase64Encoded?: string;
- /** Cloud Storage URI of the video */
- gcsUri?: string;
- /** Video MIME type */
- mimeType?: string;
+ /** Base64-encoded video content */
+ bytesBase64Encoded?: string;
+ /** Cloud Storage URI of the video */
+ gcsUri?: string;
+ /** Video MIME type */
+ mimeType?: string;
};
/**
* The actual prediction response if done is true
*/
export type Veo2GenVidPollResponseResponse = {
- "@type"?: string;
- /** Count of media filtered by responsible AI policies */
- raiMediaFilteredCount?: number;
- /** Reasons why media was filtered by responsible AI policies */
- raiMediaFilteredReasons?: string[];
- videos?: Veo2GenVidPollResponseResponseVideosItem[];
+ '@type'?: string;
+ /** Count of media filtered by responsible AI policies */
+ raiMediaFilteredCount?: number;
+ /** Reasons why media was filtered by responsible AI policies */
+ raiMediaFilteredReasons?: string[];
+ videos?: Veo2GenVidPollResponseResponseVideosItem[];
};
export interface Veo2GenVidPollResponse {
- done?: boolean;
- /** Error details if operation failed */
- error?: Veo2GenVidPollResponseError;
- name?: string;
- /** The actual prediction response if done is true */
- response?: Veo2GenVidPollResponseResponse;
+ done?: boolean;
+ /** Error details if operation failed */
+ error?: Veo2GenVidPollResponseError;
+ name?: string;
+ /** The actual prediction response if done is true */
+ response?: Veo2GenVidPollResponseResponse;
}
/**
* Optional image to guide video generation
*/
-export type Veo2GenVidRequestInstancesItemImage =
- | (unknown & {
- bytesBase64Encoded?: string;
- gcsUri?: string;
- mimeType?: string;
- })
- | (unknown & {
- bytesBase64Encoded?: string;
- gcsUri?: string;
- mimeType?: string;
- });
+export type Veo2GenVidRequestInstancesItemImage = (unknown & {
+ bytesBase64Encoded?: string;
+ gcsUri?: string;
+ mimeType?: string;
+}) | (unknown & {
+ bytesBase64Encoded?: string;
+ gcsUri?: string;
+ mimeType?: string;
+});
export type Veo2GenVidRequestInstancesItem = {
- /** Optional image to guide video generation */
- image?: Veo2GenVidRequestInstancesItemImage;
- /** Text description of the video */
- prompt: string;
+ /** Optional image to guide video generation */
+ image?: Veo2GenVidRequestInstancesItemImage;
+ /** Text description of the video */
+ prompt: string;
};
-export type Veo2GenVidRequestParametersPersonGeneration =
- (typeof Veo2GenVidRequestParametersPersonGeneration)[keyof typeof Veo2GenVidRequestParametersPersonGeneration];
+export type Veo2GenVidRequestParametersPersonGeneration = typeof Veo2GenVidRequestParametersPersonGeneration[keyof typeof Veo2GenVidRequestParametersPersonGeneration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Veo2GenVidRequestParametersPersonGeneration = {
- ALLOW: "ALLOW",
- BLOCK: "BLOCK",
+ ALLOW: 'ALLOW',
+ BLOCK: 'BLOCK',
} as const;
export type Veo2GenVidRequestParameters = {
- aspectRatio?: string;
- durationSeconds?: number;
- enhancePrompt?: boolean;
- negativePrompt?: string;
- personGeneration?: Veo2GenVidRequestParametersPersonGeneration;
- sampleCount?: number;
- seed?: number;
- /** Optional Cloud Storage URI to upload the video */
- storageUri?: string;
+ aspectRatio?: string;
+ durationSeconds?: number;
+ enhancePrompt?: boolean;
+ negativePrompt?: string;
+ personGeneration?: Veo2GenVidRequestParametersPersonGeneration;
+ sampleCount?: number;
+ seed?: number;
+ /** Optional Cloud Storage URI to upload the video */
+ storageUri?: string;
};
export interface Veo2GenVidRequest {
- instances?: Veo2GenVidRequestInstancesItem[];
- parameters?: Veo2GenVidRequestParameters;
+ instances?: Veo2GenVidRequestInstancesItem[];
+ parameters?: Veo2GenVidRequestParameters;
}
export interface Veo2GenVidResponse {
- /** Operation resource name */
- name: string;
+ /** Operation resource name */
+ name: string;
}
export interface VeoGenVidPollRequest {
- /** Full operation name (from predict response) */
- operationName: string;
+ /** Full operation name (from predict response) */
+ operationName: string;
}
/**
* Error details if operation failed
*/
export type VeoGenVidPollResponseError = {
- /** Error code */
- code?: number;
- /** Error message */
- message?: string;
+ /** Error code */
+ code?: number;
+ /** Error message */
+ message?: string;
};
export type VeoGenVidPollResponseResponseVideosItem = {
- /** Base64-encoded video content */
- bytesBase64Encoded?: string;
- /** Cloud Storage URI of the video */
- gcsUri?: string;
- /** Video MIME type */
- mimeType?: string;
+ /** Base64-encoded video content */
+ bytesBase64Encoded?: string;
+ /** Cloud Storage URI of the video */
+ gcsUri?: string;
+ /** Video MIME type */
+ mimeType?: string;
};
/**
* The actual prediction response if done is true
*/
export type VeoGenVidPollResponseResponse = {
- "@type"?: string;
- /** Count of media filtered by responsible AI policies */
- raiMediaFilteredCount?: number;
- /** Reasons why media was filtered by responsible AI policies */
- raiMediaFilteredReasons?: string[];
- videos?: VeoGenVidPollResponseResponseVideosItem[];
+ '@type'?: string;
+ /** Count of media filtered by responsible AI policies */
+ raiMediaFilteredCount?: number;
+ /** Reasons why media was filtered by responsible AI policies */
+ raiMediaFilteredReasons?: string[];
+ videos?: VeoGenVidPollResponseResponseVideosItem[];
};
export interface VeoGenVidPollResponse {
- done?: boolean;
- /** Error details if operation failed */
- error?: VeoGenVidPollResponseError;
- name?: string;
- /** The actual prediction response if done is true */
- response?: VeoGenVidPollResponseResponse;
+ done?: boolean;
+ /** Error details if operation failed */
+ error?: VeoGenVidPollResponseError;
+ name?: string;
+ /** The actual prediction response if done is true */
+ response?: VeoGenVidPollResponseResponse;
}
/**
* Optional image to guide video generation
*/
-export type VeoGenVidRequestInstancesItemImage =
- | (unknown & {
- bytesBase64Encoded?: string;
- gcsUri?: string;
- mimeType?: string;
- })
- | (unknown & {
- bytesBase64Encoded?: string;
- gcsUri?: string;
- mimeType?: string;
- });
+export type VeoGenVidRequestInstancesItemImage = (unknown & {
+ bytesBase64Encoded?: string;
+ gcsUri?: string;
+ mimeType?: string;
+}) | (unknown & {
+ bytesBase64Encoded?: string;
+ gcsUri?: string;
+ mimeType?: string;
+});
export type VeoGenVidRequestInstancesItem = {
- /** Optional image to guide video generation */
- image?: VeoGenVidRequestInstancesItemImage;
- /** Text description of the video */
- prompt: string;
+ /** Optional image to guide video generation */
+ image?: VeoGenVidRequestInstancesItemImage;
+ /** Text description of the video */
+ prompt: string;
};
-export type VeoGenVidRequestParametersPersonGeneration =
- (typeof VeoGenVidRequestParametersPersonGeneration)[keyof typeof VeoGenVidRequestParametersPersonGeneration];
+export type VeoGenVidRequestParametersPersonGeneration = typeof VeoGenVidRequestParametersPersonGeneration[keyof typeof VeoGenVidRequestParametersPersonGeneration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const VeoGenVidRequestParametersPersonGeneration = {
- ALLOW: "ALLOW",
- BLOCK: "BLOCK",
+ ALLOW: 'ALLOW',
+ BLOCK: 'BLOCK',
} as const;
export type VeoGenVidRequestParameters = {
- aspectRatio?: string;
- durationSeconds?: number;
- enhancePrompt?: boolean;
- /** Generate audio for the video. Only supported by veo 3 models. */
- generateAudio?: boolean;
- negativePrompt?: string;
- personGeneration?: VeoGenVidRequestParametersPersonGeneration;
- sampleCount?: number;
- seed?: number;
- /** Optional Cloud Storage URI to upload the video */
- storageUri?: string;
+ aspectRatio?: string;
+ durationSeconds?: number;
+ enhancePrompt?: boolean;
+ /** Generate audio for the video. Only supported by veo 3 models. */
+ generateAudio?: boolean;
+ negativePrompt?: string;
+ personGeneration?: VeoGenVidRequestParametersPersonGeneration;
+ sampleCount?: number;
+ seed?: number;
+ /** Optional Cloud Storage URI to upload the video */
+ storageUri?: string;
};
export interface VeoGenVidRequest {
- instances?: VeoGenVidRequestInstancesItem[];
- parameters?: VeoGenVidRequestParameters;
+ instances?: VeoGenVidRequestInstancesItem[];
+ parameters?: VeoGenVidRequestParameters;
}
export interface VeoGenVidResponse {
- /** Operation resource name */
- name: string;
+ /** Operation resource name */
+ name: string;
}
export interface ViduCreation {
- cover_url?: string;
- id?: string;
- moderation_url?: string[];
- url?: string;
- watermarked_url?: string;
+ cover_url?: string;
+ id?: string;
+ moderation_url?: string[];
+ url?: string;
+ watermarked_url?: string;
}
export interface ViduGetCreationsReply {
- creations?: ViduCreation[];
- err_code?: string;
- id?: string;
- state?: ViduState;
+ creations?: ViduCreation[];
+ err_code?: string;
+ id?: string;
+ state?: ViduState;
}
-export type ViduState = (typeof ViduState)[keyof typeof ViduState];
+export type ViduState = typeof ViduState[keyof typeof ViduState];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ViduState = {
- created: "created",
- processing: "processing",
- queueing: "queueing",
- success: "success",
- failed: "failed",
+ created: 'created',
+ processing: 'processing',
+ queueing: 'queueing',
+ success: 'success',
+ failed: 'failed',
} as const;
-export type ViduTaskReplyMovementAmplitude =
- (typeof ViduTaskReplyMovementAmplitude)[keyof typeof ViduTaskReplyMovementAmplitude];
+export type ViduTaskReplyMovementAmplitude = typeof ViduTaskReplyMovementAmplitude[keyof typeof ViduTaskReplyMovementAmplitude];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ViduTaskReplyMovementAmplitude = {
- auto: "auto",
- small: "small",
- medium: "medium",
- large: "large",
+ auto: 'auto',
+ small: 'small',
+ medium: 'medium',
+ large: 'large',
} as const;
-export type ViduTaskReplyStyle =
- (typeof ViduTaskReplyStyle)[keyof typeof ViduTaskReplyStyle];
+export type ViduTaskReplyStyle = typeof ViduTaskReplyStyle[keyof typeof ViduTaskReplyStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ViduTaskReplyStyle = {
- general: "general",
- anime: "anime",
+ general: 'general',
+ anime: 'anime',
} as const;
export interface ViduTaskReply {
- aspect_ratio?: string;
- created_at?: string;
- credits: number;
- duration?: number;
- images?: string[];
- model?: string;
- movement_amplitude?: ViduTaskReplyMovementAmplitude;
- prompt?: string;
- resolution?: string;
- seed?: number;
- state: ViduState;
- style?: ViduTaskReplyStyle;
- task_id: string;
+ aspect_ratio?: string;
+ created_at?: string;
+ credits: number;
+ duration?: number;
+ images?: string[];
+ model?: string;
+ movement_amplitude?: ViduTaskReplyMovementAmplitude;
+ prompt?: string;
+ resolution?: string;
+ seed?: number;
+ state: ViduState;
+ style?: ViduTaskReplyStyle;
+ task_id: string;
}
-export type ViduTaskRequestMovementAmplitude =
- (typeof ViduTaskRequestMovementAmplitude)[keyof typeof ViduTaskRequestMovementAmplitude];
+export type ViduTaskRequestMovementAmplitude = typeof ViduTaskRequestMovementAmplitude[keyof typeof ViduTaskRequestMovementAmplitude];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ViduTaskRequestMovementAmplitude = {
- auto: "auto",
- small: "small",
- medium: "medium",
- large: "large",
+ auto: 'auto',
+ small: 'small',
+ medium: 'medium',
+ large: 'large',
} as const;
-export type ViduTaskRequestStyle =
- (typeof ViduTaskRequestStyle)[keyof typeof ViduTaskRequestStyle];
+export type ViduTaskRequestStyle = typeof ViduTaskRequestStyle[keyof typeof ViduTaskRequestStyle];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ViduTaskRequestStyle = {
- general: "general",
- anime: "anime",
+ general: 'general',
+ anime: 'anime',
} as const;
export interface ViduTaskRequest {
- aspect_ratio?: string;
- callback_url?: string;
- duration?: number;
- enhance?: boolean;
- images?: string[];
- model?: string;
- movement_amplitude?: ViduTaskRequestMovementAmplitude;
- priority?: number;
- prompt?: string;
- resolution?: string;
- seed?: number;
- style?: ViduTaskRequestStyle;
+ aspect_ratio?: string;
+ callback_url?: string;
+ duration?: number;
+ enhance?: boolean;
+ images?: string[];
+ model?: string;
+ movement_amplitude?: ViduTaskRequestMovementAmplitude;
+ priority?: number;
+ prompt?: string;
+ resolution?: string;
+ seed?: number;
+ style?: ViduTaskRequestStyle;
}
/**
* Enter basic information, such as prompt words, images, etc.
*/
export type WanImage2ImageGenerationRequestInput = {
- /**
- * Array of image URLs for image-to-image generation
- * @minItems 1
- * @maxItems 2
- */
- images: string[];
- /**
- * Reverse prompt words to describe content that you do not want to see in the image
- * @maxLength 500
- */
- negative_prompt?: string;
- /**
- * Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 2000 characters
- * @maxLength 2000
- */
- prompt: string;
+ /**
+ * Array of image URLs for image-to-image generation
+ * @minItems 1
+ * @maxItems 2
+ */
+ images: string[];
+ /**
+ * Reverse prompt words to describe content that you do not want to see in the image
+ * @maxLength 500
+ */
+ negative_prompt?: string;
+ /**
+ * Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 2000 characters
+ * @maxLength 2000
+ */
+ prompt: string;
};
/**
* The ID of the model to call for image-to-image generation
*/
-export type WanImage2ImageGenerationRequestModel =
- (typeof WanImage2ImageGenerationRequestModel)[keyof typeof WanImage2ImageGenerationRequestModel];
+export type WanImage2ImageGenerationRequestModel = typeof WanImage2ImageGenerationRequestModel[keyof typeof WanImage2ImageGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanImage2ImageGenerationRequestModel = {
- "wan25-i2i-preview": "wan2.5-i2i-preview",
+ 'wan25-i2i-preview': 'wan2.5-i2i-preview',
} as const;
/**
* Image processing parameters
*/
export type WanImage2ImageGenerationRequestParameters = {
- /**
- * Number of generated images. Range 1-4, default is 1
- * @minimum 1
- * @maximum 4
- */
- n?: number;
- /**
- * Random number seed to control randomness. Range [0, 2147483647]
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- /** Output image resolution. Default is 1280*1280. Width and height must be between 384 and 5000 pixels. */
- size?: string;
- /** Whether to add watermark logo in lower right corner */
- watermark?: boolean;
+ /**
+ * Number of generated images. Range 1-4, default is 1
+ * @minimum 1
+ * @maximum 4
+ */
+ n?: number;
+ /**
+ * Random number seed to control randomness. Range [0, 2147483647]
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ /** Output image resolution. Default is 1280*1280. Width and height must be between 384 and 5000 pixels. */
+ size?: string;
+ /** Whether to add watermark logo in lower right corner */
+ watermark?: boolean;
};
export interface WanImage2ImageGenerationRequest {
- /** Enter basic information, such as prompt words, images, etc. */
- input: WanImage2ImageGenerationRequestInput;
- /** The ID of the model to call for image-to-image generation */
- model: WanImage2ImageGenerationRequestModel;
- /** Image processing parameters */
- parameters?: WanImage2ImageGenerationRequestParameters;
+ /** Enter basic information, such as prompt words, images, etc. */
+ input: WanImage2ImageGenerationRequestInput;
+ /** The ID of the model to call for image-to-image generation */
+ model: WanImage2ImageGenerationRequestModel;
+ /** Image processing parameters */
+ parameters?: WanImage2ImageGenerationRequestParameters;
}
/**
* Task status
*/
-export type WanImage2ImageGenerationResponseOutputTaskStatus =
- (typeof WanImage2ImageGenerationResponseOutputTaskStatus)[keyof typeof WanImage2ImageGenerationResponseOutputTaskStatus];
+export type WanImage2ImageGenerationResponseOutputTaskStatus = typeof WanImage2ImageGenerationResponseOutputTaskStatus[keyof typeof WanImage2ImageGenerationResponseOutputTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanImage2ImageGenerationResponseOutputTaskStatus = {
- PENDING: "PENDING",
- RUNNING: "RUNNING",
- SUCCEEDED: "SUCCEEDED",
- FAILED: "FAILED",
- CANCELED: "CANCELED",
- UNKNOWN: "UNKNOWN",
+ PENDING: 'PENDING',
+ RUNNING: 'RUNNING',
+ SUCCEEDED: 'SUCCEEDED',
+ FAILED: 'FAILED',
+ CANCELED: 'CANCELED',
+ UNKNOWN: 'UNKNOWN',
} as const;
export type WanImage2ImageGenerationResponseOutput = {
- /** Task ID */
- task_id: string;
- /** Task status */
- task_status: WanImage2ImageGenerationResponseOutputTaskStatus;
+ /** Task ID */
+ task_id: string;
+ /** Task status */
+ task_status: WanImage2ImageGenerationResponseOutputTaskStatus;
};
export interface WanImage2ImageGenerationResponse {
- /** The error code for the failed request (not returned if request is successful) */
- code?: string;
- /** Detailed information about the failed request (not returned if request is successful) */
- message?: string;
- output: WanImage2ImageGenerationResponseOutput;
- /** Unique request identifier */
- request_id: string;
+ /** The error code for the failed request (not returned if request is successful) */
+ code?: string;
+ /** Detailed information about the failed request (not returned if request is successful) */
+ message?: string;
+ output: WanImage2ImageGenerationResponseOutput;
+ /** Unique request identifier */
+ request_id: string;
}
/**
* Enter basic information, such as prompt words, etc.
*/
export type WanImageGenerationRequestInput = {
- /** Reverse prompt words to describe content that you do not want to see in the image */
- negative_prompt?: string;
- /** Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 800 characters */
- prompt: string;
+ /** Reverse prompt words to describe content that you do not want to see in the image */
+ negative_prompt?: string;
+ /** Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 800 characters */
+ prompt: string;
};
/**
* The ID of the model to call for text-to-image generation
*/
-export type WanImageGenerationRequestModel =
- (typeof WanImageGenerationRequestModel)[keyof typeof WanImageGenerationRequestModel];
+export type WanImageGenerationRequestModel = typeof WanImageGenerationRequestModel[keyof typeof WanImageGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanImageGenerationRequestModel = {
- "wan25-t2i-preview": "wan2.5-t2i-preview",
+ 'wan25-t2i-preview': 'wan2.5-t2i-preview',
} as const;
/**
* Image processing parameters
*/
export type WanImageGenerationRequestParameters = {
- /**
- * Number of generated images. Range 1-4, default is 4
- * @minimum 1
- * @maximum 4
- */
- n?: number;
- /** Enable prompt intelligent rewriting. Default is true */
- prompt_extend?: boolean;
- /**
- * Random number seed to control randomness. Range [0, 2147483647]
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- /** Output image resolution. Default is 1024*1024. Pixel range [512, 1440], up to 200 megapixels */
- size?: string;
- /** Whether to add watermark logo in lower right corner */
- watermark?: boolean;
+ /**
+ * Number of generated images. Range 1-4, default is 4
+ * @minimum 1
+ * @maximum 4
+ */
+ n?: number;
+ /** Enable prompt intelligent rewriting. Default is true */
+ prompt_extend?: boolean;
+ /**
+ * Random number seed to control randomness. Range [0, 2147483647]
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ /** Output image resolution. Default is 1024*1024. Pixel range [512, 1440], up to 200 megapixels */
+ size?: string;
+ /** Whether to add watermark logo in lower right corner */
+ watermark?: boolean;
};
export interface WanImageGenerationRequest {
- /** Enter basic information, such as prompt words, etc. */
- input: WanImageGenerationRequestInput;
- /** The ID of the model to call for text-to-image generation */
- model: WanImageGenerationRequestModel;
- /** Image processing parameters */
- parameters?: WanImageGenerationRequestParameters;
+ /** Enter basic information, such as prompt words, etc. */
+ input: WanImageGenerationRequestInput;
+ /** The ID of the model to call for text-to-image generation */
+ model: WanImageGenerationRequestModel;
+ /** Image processing parameters */
+ parameters?: WanImageGenerationRequestParameters;
}
/**
* Task status
*/
-export type WanImageGenerationResponseOutputTaskStatus =
- (typeof WanImageGenerationResponseOutputTaskStatus)[keyof typeof WanImageGenerationResponseOutputTaskStatus];
+export type WanImageGenerationResponseOutputTaskStatus = typeof WanImageGenerationResponseOutputTaskStatus[keyof typeof WanImageGenerationResponseOutputTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanImageGenerationResponseOutputTaskStatus = {
- PENDING: "PENDING",
- RUNNING: "RUNNING",
- SUCCEEDED: "SUCCEEDED",
- FAILED: "FAILED",
- CANCELED: "CANCELED",
- UNKNOWN: "UNKNOWN",
+ PENDING: 'PENDING',
+ RUNNING: 'RUNNING',
+ SUCCEEDED: 'SUCCEEDED',
+ FAILED: 'FAILED',
+ CANCELED: 'CANCELED',
+ UNKNOWN: 'UNKNOWN',
} as const;
export type WanImageGenerationResponseOutput = {
- /** Task ID */
- task_id: string;
- /** Task status */
- task_status: WanImageGenerationResponseOutputTaskStatus;
+ /** Task ID */
+ task_id: string;
+ /** Task status */
+ task_status: WanImageGenerationResponseOutputTaskStatus;
};
export interface WanImageGenerationResponse {
- /** The error code for the failed request (not returned if request is successful) */
- code?: string;
- /** Detailed information about the failed request (not returned if request is successful) */
- message?: string;
- output: WanImageGenerationResponseOutput;
- /** Unique request identifier */
- request_id: string;
+ /** The error code for the failed request (not returned if request is successful) */
+ code?: string;
+ /** Detailed information about the failed request (not returned if request is successful) */
+ message?: string;
+ output: WanImageGenerationResponseOutput;
+ /** Unique request identifier */
+ request_id: string;
}
export type WanTaskQueryResponseOutputResultsItem = {
- /** Actual prompt after intelligent rewriting (if enabled) */
- actual_prompt?: string;
- /** Image error code (returned when some tasks fail) */
- code?: string;
- /** Image error information (returned when some tasks fail) */
- message?: string;
- /** Original input prompt */
- orig_prompt?: string;
- /** Generated image URL address */
- url?: string;
+ /** Actual prompt after intelligent rewriting (if enabled) */
+ actual_prompt?: string;
+ /** Image error code (returned when some tasks fail) */
+ code?: string;
+ /** Image error information (returned when some tasks fail) */
+ message?: string;
+ /** Original input prompt */
+ orig_prompt?: string;
+ /** Generated image URL address */
+ url?: string;
};
/**
* Task result statistics for image generation tasks
*/
export type WanTaskQueryResponseOutputTaskMetrics = {
- /** Number of failed tasks */
- FAILED?: number;
- /** Number of successful tasks */
- SUCCEEDED?: number;
- /** Total number of tasks */
- TOTAL?: number;
+ /** Number of failed tasks */
+ FAILED?: number;
+ /** Number of successful tasks */
+ SUCCEEDED?: number;
+ /** Total number of tasks */
+ TOTAL?: number;
};
/**
* Task status
*/
-export type WanTaskQueryResponseOutputTaskStatus =
- (typeof WanTaskQueryResponseOutputTaskStatus)[keyof typeof WanTaskQueryResponseOutputTaskStatus];
+export type WanTaskQueryResponseOutputTaskStatus = typeof WanTaskQueryResponseOutputTaskStatus[keyof typeof WanTaskQueryResponseOutputTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanTaskQueryResponseOutputTaskStatus = {
- PENDING: "PENDING",
- RUNNING: "RUNNING",
- SUCCEEDED: "SUCCEEDED",
- FAILED: "FAILED",
- CANCELED: "CANCELED",
- UNKNOWN: "UNKNOWN",
+ PENDING: 'PENDING',
+ RUNNING: 'RUNNING',
+ SUCCEEDED: 'SUCCEEDED',
+ FAILED: 'FAILED',
+ CANCELED: 'CANCELED',
+ UNKNOWN: 'UNKNOWN',
} as const;
export type WanTaskQueryResponseOutput = {
- /** Actual prompt after intelligent rewriting (for video tasks) */
- actual_prompt?: string;
- /** Audio URL for I2V tasks with audio generation */
- check_audio?: string;
- /** The error code for the failed request (not returned if request is successful) */
- code?: string;
- /** Task completion time */
- end_time?: string;
- /** Detailed information about the failed request (not returned if request is successful) */
- message?: string;
- /** Original input prompt (for video tasks) */
- orig_prompt?: string;
- /** List of task results for image generation tasks */
- results?: WanTaskQueryResponseOutputResultsItem[];
- /** Task execution time */
- scheduled_time?: string;
- /** Task submission time */
- submit_time?: string;
- /** Task ID */
- task_id: string;
- /** Task result statistics for image generation tasks */
- task_metrics?: WanTaskQueryResponseOutputTaskMetrics;
- /** Task status */
- task_status: WanTaskQueryResponseOutputTaskStatus;
- /** Video URL for completed video generation tasks. Link validity period 24 hours */
- video_url?: string;
+ /** Actual prompt after intelligent rewriting (for video tasks) */
+ actual_prompt?: string;
+ /** Audio URL for I2V tasks with audio generation */
+ check_audio?: string;
+ /** The error code for the failed request (not returned if request is successful) */
+ code?: string;
+ /** Task completion time */
+ end_time?: string;
+ /** Detailed information about the failed request (not returned if request is successful) */
+ message?: string;
+ /** Original input prompt (for video tasks) */
+ orig_prompt?: string;
+ /** List of task results for image generation tasks */
+ results?: WanTaskQueryResponseOutputResultsItem[];
+ /** Task execution time */
+ scheduled_time?: string;
+ /** Task submission time */
+ submit_time?: string;
+ /** Task ID */
+ task_id: string;
+ /** Task result statistics for image generation tasks */
+ task_metrics?: WanTaskQueryResponseOutputTaskMetrics;
+ /** Task status */
+ task_status: WanTaskQueryResponseOutputTaskStatus;
+ /** Video URL for completed video generation tasks. Link validity period 24 hours */
+ video_url?: string;
};
/**
* Output information statistics. Only successful results are counted
*/
export type WanTaskQueryResponseUsage = {
- /** Video resolution level (I2V tasks) */
- SR?: number;
- /** Duration of generated video in seconds (I2V tasks) */
- duration?: number;
- /** Number of generated images (T2I tasks) */
- image_count?: number;
- /** Image resolution (T2I tasks) */
- size?: string;
- /** Number of generated videos (T2V tasks) */
- video_count?: number;
- /** Duration of generated video in seconds (T2V tasks) */
- video_duration?: number;
- /** Video resolution ratio (T2V tasks) */
- video_ratio?: string;
+ /** Video resolution level (I2V tasks) */
+ SR?: number;
+ /** Duration of generated video in seconds (I2V tasks) */
+ duration?: number;
+ /** Number of generated images (T2I tasks) */
+ image_count?: number;
+ /** Image resolution (T2I tasks) */
+ size?: string;
+ /** Number of generated videos (T2V tasks) */
+ video_count?: number;
+ /** Duration of generated video in seconds (T2V tasks) */
+ video_duration?: number;
+ /** Video resolution ratio (T2V tasks) */
+ video_ratio?: string;
};
export interface WanTaskQueryResponse {
- output: WanTaskQueryResponseOutput;
- /** Unique request identifier */
- request_id: string;
- /** Output information statistics. Only successful results are counted */
- usage?: WanTaskQueryResponseUsage;
+ output: WanTaskQueryResponseOutput;
+ /** Unique request identifier */
+ request_id: string;
+ /** Output information statistics. Only successful results are counted */
+ usage?: WanTaskQueryResponseUsage;
}
/**
* Enter basic information, such as prompt words, etc.
*/
export type WanVideoGenerationRequestInput = {
- /** Audio file download URL. Supported formats: mp3 and wav. */
- audio_url?: string;
- /** First frame image URL or Base64 encoded data. Required for I2V models. Image formats: JPEG, JPG, PNG, BMP, WEBP. Resolution: 360-2000 pixels. File size: max 10MB. */
- img_url?: string;
- /**
- * Reverse prompt words are used to describe content that you do not want to see in the video screen
- * @maxLength 500
- */
- negative_prompt?: string;
- /**
- * Text prompt words. Support Chinese and English, length not exceeding 800 characters
- * @maxLength 800
- */
- prompt: string;
- /** Video effect template name. Optional. Currently supported: squish, flying, carousel. When used, prompt parameter is ignored. */
- template?: string;
+ /** Audio file download URL. Supported formats: mp3 and wav. */
+ audio_url?: string;
+ /** First frame image URL or Base64 encoded data. Required for I2V models. Image formats: JPEG, JPG, PNG, BMP, WEBP. Resolution: 360-2000 pixels. File size: max 10MB. */
+ img_url?: string;
+ /**
+ * Reverse prompt words are used to describe content that you do not want to see in the video screen
+ * @maxLength 500
+ */
+ negative_prompt?: string;
+ /**
+ * Text prompt words. Support Chinese and English, length not exceeding 800 characters
+ * @maxLength 800
+ */
+ prompt: string;
+ /** Video effect template name. Optional. Currently supported: squish, flying, carousel. When used, prompt parameter is ignored. */
+ template?: string;
};
/**
* The ID of the model to call
*/
-export type WanVideoGenerationRequestModel =
- (typeof WanVideoGenerationRequestModel)[keyof typeof WanVideoGenerationRequestModel];
+export type WanVideoGenerationRequestModel = typeof WanVideoGenerationRequestModel[keyof typeof WanVideoGenerationRequestModel];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanVideoGenerationRequestModel = {
- "wan25-t2v-preview": "wan2.5-t2v-preview",
- "wan25-i2v-preview": "wan2.5-i2v-preview",
+ 'wan25-t2v-preview': 'wan2.5-t2v-preview',
+ 'wan25-i2v-preview': 'wan2.5-i2v-preview',
} as const;
/**
* The duration of the video generated, in seconds
*/
-export type WanVideoGenerationRequestParametersDuration =
- (typeof WanVideoGenerationRequestParametersDuration)[keyof typeof WanVideoGenerationRequestParametersDuration];
+export type WanVideoGenerationRequestParametersDuration = typeof WanVideoGenerationRequestParametersDuration[keyof typeof WanVideoGenerationRequestParametersDuration];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanVideoGenerationRequestParametersDuration = {
- NUMBER_5: 5,
- NUMBER_10: 10,
+ NUMBER_5: 5,
+ NUMBER_10: 10,
} as const;
/**
* Resolution level for I2V models. Supported values vary by model: 480P, 720P, 1080P
*/
-export type WanVideoGenerationRequestParametersResolution =
- (typeof WanVideoGenerationRequestParametersResolution)[keyof typeof WanVideoGenerationRequestParametersResolution];
+export type WanVideoGenerationRequestParametersResolution = typeof WanVideoGenerationRequestParametersResolution[keyof typeof WanVideoGenerationRequestParametersResolution];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanVideoGenerationRequestParametersResolution = {
- "480P": "480P",
- "720P": "720P",
- "1080P": "1080P",
+ '480P': '480P',
+ '720P': '720P',
+ '1080P': '1080P',
} as const;
/**
* Video processing parameters
*/
export type WanVideoGenerationRequestParameters = {
- /** Whether to add audio to the video */
- audio?: boolean;
- /** The duration of the video generated, in seconds */
- duration?: WanVideoGenerationRequestParametersDuration;
- /** Is it enabled prompt intelligent rewriting. Default is true */
- prompt_extend?: boolean;
- /** Resolution level for I2V models. Supported values vary by model: 480P, 720P, 1080P */
- resolution?: WanVideoGenerationRequestParametersResolution;
- /**
- * Random number seed, used to control the randomness of the model generated content
- * @minimum 0
- * @maximum 2147483647
- */
- seed?: number;
- /** Used to specify the video resolution in the format of 宽*高. Supported resolutions vary by model (for T2V models) */
- size?: string;
- /** Whether to add a watermark logo, the watermark is located in the lower right corner */
- watermark?: boolean;
+ /** Whether to add audio to the video */
+ audio?: boolean;
+ /** The duration of the video generated, in seconds */
+ duration?: WanVideoGenerationRequestParametersDuration;
+ /** Is it enabled prompt intelligent rewriting. Default is true */
+ prompt_extend?: boolean;
+ /** Resolution level for I2V models. Supported values vary by model: 480P, 720P, 1080P */
+ resolution?: WanVideoGenerationRequestParametersResolution;
+ /**
+ * Random number seed, used to control the randomness of the model generated content
+ * @minimum 0
+ * @maximum 2147483647
+ */
+ seed?: number;
+ /** Used to specify the video resolution in the format of 宽*高. Supported resolutions vary by model (for T2V models) */
+ size?: string;
+ /** Whether to add a watermark logo, the watermark is located in the lower right corner */
+ watermark?: boolean;
};
export interface WanVideoGenerationRequest {
- /** Enter basic information, such as prompt words, etc. */
- input: WanVideoGenerationRequestInput;
- /** The ID of the model to call */
- model: WanVideoGenerationRequestModel;
- /** Video processing parameters */
- parameters?: WanVideoGenerationRequestParameters;
+ /** Enter basic information, such as prompt words, etc. */
+ input: WanVideoGenerationRequestInput;
+ /** The ID of the model to call */
+ model: WanVideoGenerationRequestModel;
+ /** Video processing parameters */
+ parameters?: WanVideoGenerationRequestParameters;
}
/**
* Task status
*/
-export type WanVideoGenerationResponseOutputTaskStatus =
- (typeof WanVideoGenerationResponseOutputTaskStatus)[keyof typeof WanVideoGenerationResponseOutputTaskStatus];
+export type WanVideoGenerationResponseOutputTaskStatus = typeof WanVideoGenerationResponseOutputTaskStatus[keyof typeof WanVideoGenerationResponseOutputTaskStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WanVideoGenerationResponseOutputTaskStatus = {
- PENDING: "PENDING",
- RUNNING: "RUNNING",
- SUCCEEDED: "SUCCEEDED",
- FAILED: "FAILED",
- CANCELED: "CANCELED",
- UNKNOWN: "UNKNOWN",
+ PENDING: 'PENDING',
+ RUNNING: 'RUNNING',
+ SUCCEEDED: 'SUCCEEDED',
+ FAILED: 'FAILED',
+ CANCELED: 'CANCELED',
+ UNKNOWN: 'UNKNOWN',
} as const;
export type WanVideoGenerationResponseOutput = {
- /** Task ID */
- task_id: string;
- /** Task status */
- task_status: WanVideoGenerationResponseOutputTaskStatus;
+ /** Task ID */
+ task_id: string;
+ /** Task status */
+ task_status: WanVideoGenerationResponseOutputTaskStatus;
};
export interface WanVideoGenerationResponse {
- /** The error code for the failed request (not returned if request is successful) */
- code?: string;
- /** Detailed information about the failed request (not returned if request is successful) */
- message?: string;
- output: WanVideoGenerationResponseOutput;
- /** Unique request identifier */
- request_id: string;
+ /** The error code for the failed request (not returned if request is successful) */
+ code?: string;
+ /** Detailed information about the failed request (not returned if request is successful) */
+ message?: string;
+ output: WanVideoGenerationResponseOutput;
+ /** Unique request identifier */
+ request_id: string;
}
/**
* High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.
*/
-export type WebSearchPreviewToolSearchContextSize =
- (typeof WebSearchPreviewToolSearchContextSize)[keyof typeof WebSearchPreviewToolSearchContextSize];
+export type WebSearchPreviewToolSearchContextSize = typeof WebSearchPreviewToolSearchContextSize[keyof typeof WebSearchPreviewToolSearchContextSize];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WebSearchPreviewToolSearchContextSize = {
- low: "low",
- medium: "medium",
- high: "high",
+ low: 'low',
+ medium: 'medium',
+ high: 'high',
} as const;
/**
* The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.
*/
-export type WebSearchPreviewToolType =
- (typeof WebSearchPreviewToolType)[keyof typeof WebSearchPreviewToolType];
+export type WebSearchPreviewToolType = typeof WebSearchPreviewToolType[keyof typeof WebSearchPreviewToolType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WebSearchPreviewToolType = {
- web_search_preview: "web_search_preview",
- web_search_preview_2025_03_11: "web_search_preview_2025_03_11",
+ web_search_preview: 'web_search_preview',
+ web_search_preview_2025_03_11: 'web_search_preview_2025_03_11',
} as const;
/**
* This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
*/
export interface WebSearchPreviewTool {
- /** High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. */
- search_context_size?: WebSearchPreviewToolSearchContextSize;
- /** The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. */
- type: WebSearchPreviewToolType;
+ /** High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. */
+ search_context_size?: WebSearchPreviewToolSearchContextSize;
+ /** The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. */
+ type: WebSearchPreviewToolType;
}
/**
* The status of the web search tool call.
*/
-export type WebSearchToolCallStatus =
- (typeof WebSearchToolCallStatus)[keyof typeof WebSearchToolCallStatus];
+export type WebSearchToolCallStatus = typeof WebSearchToolCallStatus[keyof typeof WebSearchToolCallStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WebSearchToolCallStatus = {
- in_progress: "in_progress",
- searching: "searching",
- completed: "completed",
- failed: "failed",
+ in_progress: 'in_progress',
+ searching: 'searching',
+ completed: 'completed',
+ failed: 'failed',
} as const;
/**
* The type of the web search tool call. Always `web_search_call`.
*/
-export type WebSearchToolCallType =
- (typeof WebSearchToolCallType)[keyof typeof WebSearchToolCallType];
+export type WebSearchToolCallType = typeof WebSearchToolCallType[keyof typeof WebSearchToolCallType];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WebSearchToolCallType = {
- web_search_call: "web_search_call",
+ web_search_call: 'web_search_call',
} as const;
/**
@@ -9079,25 +9169,25 @@ export const WebSearchToolCallType = {
*/
export interface WebSearchToolCall {
- /** The unique ID of the web search tool call.
- */
- id: string;
- /** The status of the web search tool call.
- */
- status: WebSearchToolCallStatus;
- /** The type of the web search tool call. Always `web_search_call`.
- */
- type: WebSearchToolCallType;
+ /** The unique ID of the web search tool call.
+ */
+ id: string;
+ /** The status of the web search tool call.
+ */
+ status: WebSearchToolCallStatus;
+ /** The type of the web search tool call. Always `web_search_call`.
+ */
+ type: WebSearchToolCallType;
}
-export type WorkflowRunStatus =
- (typeof WorkflowRunStatus)[keyof typeof WorkflowRunStatus];
+export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const WorkflowRunStatus = {
- WorkflowRunStatusStarted: "WorkflowRunStatusStarted",
- WorkflowRunStatusFailed: "WorkflowRunStatusFailed",
- WorkflowRunStatusCompleted: "WorkflowRunStatusCompleted",
+ WorkflowRunStatusStarted: 'WorkflowRunStatusStarted',
+ WorkflowRunStatusFailed: 'WorkflowRunStatusFailed',
+ WorkflowRunStatusCompleted: 'WorkflowRunStatusCompleted',
} as const;
/**
@@ -9106,623 +9196,646 @@ export const WorkflowRunStatus = {
export type PixverseAiTraceIdParameter = string;
export type AdminUpdateNodeVersionBody = {
- status?: NodeVersionStatus;
- /** The reason for the status change. */
- status_reason?: string;
- /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
- supported_accelerators?: string[];
- /** Supported versions of ComfyUI frontend */
- supported_comfyui_frontend_version?: string;
- /** Supported versions of ComfyUI */
- supported_comfyui_version?: string;
- /** List of operating systems that this node supports */
- supported_os?: string[];
+ status?: NodeVersionStatus;
+ /** The reason for the status change. */
+ status_reason?: string;
+ /** List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports */
+ supported_accelerators?: string[];
+ /** Supported versions of ComfyUI frontend */
+ supported_comfyui_frontend_version?: string;
+ /** Supported versions of ComfyUI */
+ supported_comfyui_version?: string;
+ /** List of operating systems that this node supports */
+ supported_os?: string[];
};
export type GetBranchParams = {
- /**
- * The repo to filter by.
- */
- repo_name?: string;
+/**
+ * The repo to filter by.
+ */
+repo_name?: string;
};
export type GetBranch200 = {
- branches?: string[];
+ branches?: string[];
+};
+
+export type ListAllComfyNodesParams = {
+pageSize?: number;
+/**
+ * Page number (1-based indexing)
+ */
+page?: number;
+/**
+ * Filter by node ID
+ */
+node_id?: string;
+/**
+ * Filter by node version
+ */
+node_version?: string;
+/**
+ * Filter by ComfyUI node name
+ */
+comfy_node_name?: string;
+};
+
+export type ListAllComfyNodes200 = {
+ comfy_nodes?: ComfyNode[];
+ /** Total number of comfy nodes */
+ total?: number;
};
export type ComfyNodesBackfillParams = {
- max_node?: number;
+max_node?: number;
};
export type SearchCustomersParams = {
- /**
- * Email address to search for
- */
- email?: string;
- /**
- * Customer name to search for
- */
- name?: string;
- /**
- * Stripe customer ID to search for
- */
- stripe_id?: string;
- /**
- * Metronome customer ID to search for\
- */
- metronome_id?: string;
- /**
- * Page number to retrieve
- */
- page?: number;
- /**
- * Number of customers to return per page
- */
- limit?: number;
+/**
+ * Email address to search for
+ */
+email?: string;
+/**
+ * Customer name to search for
+ */
+name?: string;
+/**
+ * Stripe customer ID to search for
+ */
+stripe_id?: string;
+/**
+ * Metronome customer ID to search for\
+ */
+metronome_id?: string;
+/**
+ * Page number to retrieve
+ */
+page?: number;
+/**
+ * Number of customers to return per page
+ */
+limit?: number;
};
export type SearchCustomers200 = {
- customers?: Customer[];
- /** Number of customers per page */
- limit?: number;
- /** Current page number */
- page?: number;
- /** Total number of matching customers */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ customers?: Customer[];
+ /** Number of customers per page */
+ limit?: number;
+ /** Current page number */
+ page?: number;
+ /** Total number of matching customers */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type ListCustomerAPIKeys200 = {
- api_keys?: APIKey[];
+ api_keys?: APIKey[];
};
export type CreateCustomerAPIKey201 = {
- api_key?: APIKeyWithPlaintext;
+ api_key?: APIKeyWithPlaintext;
};
export type GetCustomerBalance200 = {
- /** The remaining balance in microamount (1/1,000,000 of the currency unit) */
- amount_micros: number;
- /** The currency code (e.g., "usd") */
- currency: string;
+ /** The remaining balance in microamount (1/1,000,000 of the currency unit) */
+ amount_micros: number;
+ /** The currency code (e.g., "usd") */
+ currency: string;
};
export type AccessBillingPortalBody = {
- /** Optional URL to redirect the customer after they're done with the billing portal */
- return_url?: string;
+ /** Optional URL to redirect the customer after they're done with the billing portal */
+ return_url?: string;
};
export type AccessBillingPortal200 = {
- /** The URL to redirect the customer to the billing portal */
- billing_portal_url?: string;
+ /** The URL to redirect the customer to the billing portal */
+ billing_portal_url?: string;
};
export type InitiateCreditPurchaseBody = {
- /** the amount of the checkout transaction in micro value */
- amount_micros: number;
- /** the currency used in the checkout transaction */
- currency: string;
+ /** the amount of the checkout transaction in micro value */
+ amount_micros: number;
+ /** the currency used in the checkout transaction */
+ currency: string;
};
export type InitiateCreditPurchase201 = {
- /** the url to redirect the customer */
- checkout_url?: string;
+ /** the url to redirect the customer */
+ checkout_url?: string;
};
export type GetCustomerEventsParams = {
- /**
- * Page number of the nodes list
- */
- page?: number;
- /**
- * Number of nodes to return per page
- */
- limit?: number;
- /**
- * Event type to filter
- */
- filter?: string;
+/**
+ * Page number of the nodes list
+ */
+page?: number;
+/**
+ * Number of nodes to return per page
+ */
+limit?: number;
+/**
+ * Event type to filter
+ */
+filter?: string;
};
export type GetCustomerEvents200 = {
- events?: AuditLog[];
- /** Maximum number of nodes per page */
- limit?: number;
- /** Current page number */
- page?: number;
- /** Total number of events available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ events?: AuditLog[];
+ /** Maximum number of nodes per page */
+ limit?: number;
+ /** Current page number */
+ page?: number;
+ /** Total number of events available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type CreateCustomerStorageResourceBody = {
- /** The content type of the file (e.g., 'image/png') */
- content_type?: string;
- /** The hash of the file. If provided, an existing file with the same hash may be returned. */
- file_hash?: string;
- /** The desired name of the file (e.g., 'profile.jpg') */
- file_name: string;
+ /** The content type of the file (e.g., 'image/png') */
+ content_type?: string;
+ /** The hash of the file. If provided, an existing file with the same hash may be returned. */
+ file_hash?: string;
+ /** The desired name of the file (e.g., 'profile.jpg') */
+ file_name: string;
};
export type GetCustomerUsage200 = {
- /** The dashboard URL for the customer's usage */
- url?: string;
+ /** The dashboard URL for the customer's usage */
+ url?: string;
};
export type GetCustomerById200 = {
- customer?: Customer;
+ customer?: Customer;
};
export type GetCustomerBalanceById200 = {
- /** The remaining balance in microamount (1/1,000,000 of the currency unit) */
- amount_micros: number;
- /** The currency code (e.g., "usd") */
- currency: string;
+ /** The remaining balance in microamount (1/1,000,000 of the currency unit) */
+ amount_micros: number;
+ /** The currency code (e.g., "usd") */
+ currency: string;
};
export type GetCustomerEventsByIdParams = {
- /**
- * Page number of the nodes list
- */
- page?: number;
- /**
- * Number of nodes to return per page
- */
- limit?: number;
- /**
- * Event type to filter
- */
- filter?: string;
+/**
+ * Page number of the nodes list
+ */
+page?: number;
+/**
+ * Number of nodes to return per page
+ */
+limit?: number;
+/**
+ * Event type to filter
+ */
+filter?: string;
};
export type GetCustomerEventsById200 = {
- events?: AuditLog[];
- /** Maximum number of nodes per page */
- limit?: number;
- /** Current page number */
- page?: number;
- /** Total number of events available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ events?: AuditLog[];
+ /** Maximum number of nodes per page */
+ limit?: number;
+ /** Current page number */
+ page?: number;
+ /** Total number of events available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type GetGitcommitParams = {
- /**
- * The ID of the commit to fetch data for.
- */
- commitId?: string;
- /**
- * The operating system to filter the CI data by.
- */
- operatingSystem?: string;
- /**
- * The name of the workflow to filter the CI data by.
- */
- workflowName?: string;
- /**
- * The branch of the gitcommit to filter the CI data by.
- */
- branch?: string;
- /**
- * The page number to retrieve.
- */
- page?: number;
- /**
- * The number of items to include per page.
- */
- pageSize?: number;
- /**
- * The repo to filter by.
- */
- repoName?: string;
+/**
+ * The ID of the commit to fetch data for.
+ */
+commitId?: string;
+/**
+ * The operating system to filter the CI data by.
+ */
+operatingSystem?: string;
+/**
+ * The name of the workflow to filter the CI data by.
+ */
+workflowName?: string;
+/**
+ * The branch of the gitcommit to filter the CI data by.
+ */
+branch?: string;
+/**
+ * The page number to retrieve.
+ */
+page?: number;
+/**
+ * The number of items to include per page.
+ */
+pageSize?: number;
+/**
+ * The repo to filter by.
+ */
+repoName?: string;
};
export type GetGitcommit200 = {
- jobResults?: ActionJobResult[];
- totalNumberOfPages?: number;
+ jobResults?: ActionJobResult[];
+ totalNumberOfPages?: number;
};
export type GetGitcommitsummaryParams = {
- /**
- * The repository name to filter the git commits by.
- */
- repoName?: string;
- /**
- * The branch name to filter the git commits by.
- */
- branchName?: string;
- /**
- * The page number to retrieve.
- */
- page?: number;
- /**
- * The number of items to include per page.
- */
- pageSize?: number;
+/**
+ * The repository name to filter the git commits by.
+ */
+repoName?: string;
+/**
+ * The branch name to filter the git commits by.
+ */
+branchName?: string;
+/**
+ * The page number to retrieve.
+ */
+page?: number;
+/**
+ * The number of items to include per page.
+ */
+pageSize?: number;
};
export type GetGitcommitsummary200 = {
- commitSummaries?: GitCommitSummary[];
- totalNumberOfPages?: number;
+ commitSummaries?: GitCommitSummary[];
+ totalNumberOfPages?: number;
};
export type GetGitcommitsummary500 = {
- message?: string;
+ message?: string;
};
export type ListAllNodesParams = {
- /**
- * Page number of the nodes list
- */
- page?: number;
- /**
- * Number of nodes to return per page
- */
- limit?: number;
- /**
- * Filter nodes by supported operating systems
- */
- supported_os?: string;
- /**
- * Filter nodes by supported accelerator
- */
- supported_accelerator?: string;
- /**
- * Number of nodes to return per page
- */
- include_banned?: boolean;
- /**
- * Retrieve nodes created or updated after this timestamp (ISO 8601 format)
- */
- timestamp?: string;
- /**
- * Whether to fetch fresh result from database or use cached one if false
- */
- latest?: boolean;
- /**
- * Database column to use as ascending ordering. Add `;desc` as suffix on each column for descending sort
- */
- sort?: string[];
- /**
- * node_id to use as filter
- */
- node_id?: string[];
- /**
- * Comfy UI version
- */
- comfyui_version?: string;
- /**
- * The platform requesting the nodes
- */
- form_factor?: string;
+/**
+ * Page number of the nodes list
+ */
+page?: number;
+/**
+ * Number of nodes to return per page
+ */
+limit?: number;
+/**
+ * Filter nodes by supported operating systems
+ */
+supported_os?: string;
+/**
+ * Filter nodes by supported accelerator
+ */
+supported_accelerator?: string;
+/**
+ * Number of nodes to return per page
+ */
+include_banned?: boolean;
+/**
+ * Retrieve nodes created or updated after this timestamp (ISO 8601 format)
+ */
+timestamp?: string;
+/**
+ * Whether to fetch fresh result from database or use cached one if false
+ */
+latest?: boolean;
+/**
+ * Database column to use as ascending ordering. Add `;desc` as suffix on each column for descending sort
+ */
+sort?: string[];
+/**
+ * node_id to use as filter
+ */
+node_id?: string[];
+/**
+ * Comfy UI version
+ */
+comfyui_version?: string;
+/**
+ * The platform requesting the nodes
+ */
+form_factor?: string;
};
export type ListAllNodes200 = {
- /** Maximum number of nodes per page */
- limit?: number;
- nodes?: Node[];
- /** Current page number */
- page?: number;
- /** Total number of nodes available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ /** Maximum number of nodes per page */
+ limit?: number;
+ nodes?: Node[];
+ /** Current page number */
+ page?: number;
+ /** Total number of nodes available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type ReindexNodesParams = {
- /**
- * Maximum number of nodes to send to algolia at a time
- */
- max_batch?: number;
+/**
+ * Maximum number of nodes to send to algolia at a time
+ */
+max_batch?: number;
};
export type SearchNodesParams = {
- /**
- * Page number of the nodes list
- */
- page?: number;
- /**
- * Number of nodes to return per page
- */
- limit?: number;
- /**
- * Keyword to search the nodes
- */
- search?: string;
- /**
- * Keyword to search the nodes by repository URL
- */
- repository_url_search?: string;
- /**
- * Keyword to search the nodes by comfy node name
- */
- comfy_node_search?: string;
- /**
- * Filter nodes by supported operating systems
- */
- supported_os?: string;
- /**
- * Filter nodes by supported accelerator
- */
- supported_accelerator?: string;
- /**
- * Number of nodes to return per page
- */
- include_banned?: boolean;
+/**
+ * Page number of the nodes list
+ */
+page?: number;
+/**
+ * Number of nodes to return per page
+ */
+limit?: number;
+/**
+ * Keyword to search the nodes
+ */
+search?: string;
+/**
+ * Keyword to search the nodes by repository URL
+ */
+repository_url_search?: string;
+/**
+ * Keyword to search the nodes by comfy node name
+ */
+comfy_node_search?: string;
+/**
+ * Filter nodes by supported operating systems
+ */
+supported_os?: string;
+/**
+ * Filter nodes by supported accelerator
+ */
+supported_accelerator?: string;
+/**
+ * Number of nodes to return per page
+ */
+include_banned?: boolean;
};
export type SearchNodes200 = {
- /** Maximum number of nodes per page */
- limit?: number;
- nodes?: Node[];
- /** Current page number */
- page?: number;
- /** Total number of nodes available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ /** Maximum number of nodes per page */
+ limit?: number;
+ nodes?: Node[];
+ /** Current page number */
+ page?: number;
+ /** Total number of nodes available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type UpdateGithubStarsParams = {
- /**
- * Maximum number of nodes to update in one batch
- */
- max_batch?: number;
+/**
+ * Maximum number of nodes to update in one batch
+ */
+max_batch?: number;
};
export type GetNodeParams = {
- /**
- * Whether to include the translation or not
- */
- include_translations?: boolean;
+/**
+ * Whether to include the translation or not
+ */
+include_translations?: boolean;
};
export type InstallNodeParams = {
- /**
- * Specific version of the node to retrieve. If omitted, the latest version is returned.
- * @pattern ^\d+\.\d+\.\d+$
- */
- version?: string;
+/**
+ * Specific version of the node to retrieve. If omitted, the latest version is returned.
+ * @pattern ^\d+\.\d+\.\d+$
+ */
+version?: string;
};
export type PostNodeReviewParams = {
- /**
- * number of star given to the node version
- */
- star: number;
+/**
+ * number of star given to the node version
+ */
+star: number;
};
-export type CreateNodeTranslationsBodyData = {
- [key: string]: { [key: string]: unknown };
-};
+export type CreateNodeTranslationsBodyData = {[key: string]: { [key: string]: unknown }};
export type CreateNodeTranslationsBody = {
- data?: CreateNodeTranslationsBodyData;
+ data?: CreateNodeTranslationsBodyData;
};
export type ListNodeVersionsParams = {
- statuses?: NodeVersionStatus[];
- include_status_reason?: boolean;
+statuses?: NodeVersionStatus[];
+include_status_reason?: boolean;
};
export type ListComfyNodesParams = {
- /**
- * The page number to retrieve.
- */
- page?: number;
- /**
- * The number of items to include per page.
- */
- limit?: number;
+/**
+ * The page number to retrieve.
+ */
+page?: number;
+/**
+ * The number of items to include per page.
+ */
+limit?: number;
};
export type ListComfyNodes200 = {
- comfy_nodes?: ComfyNode[];
- totalNumberOfPages?: number;
+ comfy_nodes?: ComfyNode[];
+ totalNumberOfPages?: number;
};
-export type CreateComfyNodesBodyNodes = { [key: string]: ComfyNode };
+export type CreateComfyNodesBodyNodes = {[key: string]: ComfyNode};
export type CreateComfyNodesBody = {
- cloud_build_info?: ComfyNodeCloudBuildInfo;
- nodes?: CreateComfyNodesBodyNodes;
- reason?: string;
- status?: string;
- success?: boolean;
+ cloud_build_info?: ComfyNodeCloudBuildInfo;
+ nodes?: CreateComfyNodesBodyNodes;
+ reason?: string;
+ status?: string;
+ success?: boolean;
};
-export type BFLProCannyV1FluxPro10CannyPost200 =
- | BFLAsyncResponse
- | BFLAsyncWebhookResponse;
+export type BFLProCannyV1FluxPro10CannyPost200 = BFLAsyncResponse | BFLAsyncWebhookResponse;
-export type BFLProDepthV1FluxPro10DepthPost200 =
- | BFLAsyncResponse
- | BFLAsyncWebhookResponse;
+export type BFLProDepthV1FluxPro10DepthPost200 = BFLAsyncResponse | BFLAsyncWebhookResponse;
-export type BFLExpandV1FluxPro10ExpandPost200 =
- | BFLAsyncResponse
- | BFLAsyncWebhookResponse;
+export type BFLExpandV1FluxPro10ExpandPost200 = BFLAsyncResponse | BFLAsyncWebhookResponse;
-export type BFLFillV1FluxPro10FillPost200 =
- | BFLAsyncResponse
- | BFLAsyncWebhookResponse;
+export type BFLFillV1FluxPro10FillPost200 = BFLAsyncResponse | BFLAsyncWebhookResponse;
export type DummyProxyBody = {
- message?: string;
+ message?: string;
};
export type KlingQueryResourcePackagesParams = {
- /**
- * Start time for the query, Unix timestamp in ms
- */
- start_time: number;
- /**
- * End time for the query, Unix timestamp in ms
- */
- end_time: number;
- /**
- * Resource package name for precise querying of a specific package
- */
- resource_pack_name?: string;
+/**
+ * Start time for the query, Unix timestamp in ms
+ */
+start_time: number;
+/**
+ * End time for the query, Unix timestamp in ms
+ */
+end_time: number;
+/**
+ * Resource package name for precise querying of a specific package
+ */
+resource_pack_name?: string;
};
export type KlingImageGenerationsQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingVirtualTryOnQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingVideoEffectsQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingImage2VideoQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingLipSyncQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingText2VideoQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type KlingVideoExtendQueryTaskListParams = {
- /**
- * Page number
- * @minimum 1
- * @maximum 1000
- */
- pageNum?: number;
- /**
- * Data volume per page
- * @minimum 1
- * @maximum 500
- */
- pageSize?: number;
+/**
+ * Page number
+ * @minimum 1
+ * @maximum 1000
+ */
+pageNum?: number;
+/**
+ * Data volume per page
+ * @minimum 1
+ * @maximum 500
+ */
+pageSize?: number;
};
export type RetrieveMinimaxFileParams = {
- /**
- * Unique identifier for the file, obtained from the generation response
- */
- file_id: number;
+/**
+ * Unique identifier for the file, obtained from the generation response
+ */
+file_id: number;
};
export type GetMinimaxVideoGenerationParams = {
- /**
- * The task ID to be queried
- */
- task_id: string;
+/**
+ * The task ID to be queried
+ */
+task_id: string;
};
export type GetOpenAIResponseParams = {
- /**
+/**
* Additional fields to include in the response. See the `include`
parameter for Response creation above for more information.
*/
- include?: Includable[];
+include?: Includable[];
+};
+
+export type OpenAIDownloadVideoContentParams = {
+/**
+ * Which downloadable asset to return
+ */
+variant?: string;
};
export type PixverseUploadImageBody = {
- image?: Blob;
+ image?: Blob;
};
export type RecraftCrispUpscaleBody = {
- /** Image file to process */
- file: Blob;
+ /** Image file to process */
+ file: Blob;
};
export type RecraftRemoveBackgroundBody = {
- /** Image file to process */
- file: Blob;
+ /** Image file to process */
+ file: Blob;
};
export type RecraftRemoveBackground200Image = {
- /** URL of the processed image */
- url?: string;
+ /** URL of the processed image */
+ url?: string;
};
export type RecraftRemoveBackground200 = {
- image?: RecraftRemoveBackground200Image;
+ image?: RecraftRemoveBackground200Image;
};
export type RecraftVectorizeBody = {
- /** Image file to process */
- file: Blob;
+ /** Image file to process */
+ file: Blob;
};
/**
@@ -9732,30 +9845,30 @@ export type RecraftVectorizeBody = {
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityGetResult200OneFinishReason =
- (typeof StabilityGetResult200OneFinishReason)[keyof typeof StabilityGetResult200OneFinishReason];
+export type StabilityGetResult200OneFinishReason = typeof StabilityGetResult200OneFinishReason[keyof typeof StabilityGetResult200OneFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityGetResult200OneFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityGetResult200One = {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityGetResult200OneFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityGetResult200OneFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
/**
@@ -9765,30 +9878,30 @@ export type StabilityGetResult200One = {
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityGetResult200TwoFinishReason =
- (typeof StabilityGetResult200TwoFinishReason)[keyof typeof StabilityGetResult200TwoFinishReason];
+export type StabilityGetResult200TwoFinishReason = typeof StabilityGetResult200TwoFinishReason[keyof typeof StabilityGetResult200TwoFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityGetResult200TwoFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityGetResult200Two = {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityGetResult200TwoFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityGetResult200TwoFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
/**
@@ -9798,116 +9911,116 @@ export type StabilityGetResult200Two = {
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result.
*/
-export type StabilityGetResult200ThreeFinishReason =
- (typeof StabilityGetResult200ThreeFinishReason)[keyof typeof StabilityGetResult200ThreeFinishReason];
+export type StabilityGetResult200ThreeFinishReason = typeof StabilityGetResult200ThreeFinishReason[keyof typeof StabilityGetResult200ThreeFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityGetResult200ThreeFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityGetResult200Three = {
- /** The reason the generation finished.
+ /** The reason the generation finished.
- `SUCCESS` = successful generation.
- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation
policy and has been blurred as a result. */
- finish_reason: StabilityGetResult200ThreeFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ finish_reason: StabilityGetResult200ThreeFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
/**
* Controls the aspect ratio of the generated image.
*/
-export type StabilityImageGenrationUltraBodyAspectRatio =
- (typeof StabilityImageGenrationUltraBodyAspectRatio)[keyof typeof StabilityImageGenrationUltraBodyAspectRatio];
+export type StabilityImageGenrationUltraBodyAspectRatio = typeof StabilityImageGenrationUltraBodyAspectRatio[keyof typeof StabilityImageGenrationUltraBodyAspectRatio];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltraBodyAspectRatio = {
- "21:9": "21:9",
- "16:9": "16:9",
- "3:2": "3:2",
- "5:4": "5:4",
- "1:1": "1:1",
- "4:5": "4:5",
- "2:3": "2:3",
- "9:16": "9:16",
- "9:21": "9:21",
+ '21:9': '21:9',
+ '16:9': '16:9',
+ '3:2': '3:2',
+ '5:4': '5:4',
+ '1:1': '1:1',
+ '4:5': '4:5',
+ '2:3': '2:3',
+ '9:16': '9:16',
+ '9:21': '9:21',
} as const;
/**
* Dictates the `content-type` of the generated image.
*/
-export type StabilityImageGenrationUltraBodyOutputFormat =
- (typeof StabilityImageGenrationUltraBodyOutputFormat)[keyof typeof StabilityImageGenrationUltraBodyOutputFormat];
+export type StabilityImageGenrationUltraBodyOutputFormat = typeof StabilityImageGenrationUltraBodyOutputFormat[keyof typeof StabilityImageGenrationUltraBodyOutputFormat];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltraBodyOutputFormat = {
- jpeg: "jpeg",
- png: "png",
- webp: "webp",
+ jpeg: 'jpeg',
+ png: 'png',
+ webp: 'webp',
} as const;
/**
* Guides the image model towards a particular style.
*/
-export type StabilityImageGenrationUltraBodyStylePreset =
- (typeof StabilityImageGenrationUltraBodyStylePreset)[keyof typeof StabilityImageGenrationUltraBodyStylePreset];
+export type StabilityImageGenrationUltraBodyStylePreset = typeof StabilityImageGenrationUltraBodyStylePreset[keyof typeof StabilityImageGenrationUltraBodyStylePreset];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltraBodyStylePreset = {
- enhance: "enhance",
- anime: "anime",
- photographic: "photographic",
- "digital-art": "digital-art",
- "comic-book": "comic-book",
- "fantasy-art": "fantasy-art",
- "line-art": "line-art",
- "analog-film": "analog-film",
- "neon-punk": "neon-punk",
- isometric: "isometric",
- "low-poly": "low-poly",
- origami: "origami",
- "modeling-compound": "modeling-compound",
- cinematic: "cinematic",
- "3d-model": "3d-model",
- "pixel-art": "pixel-art",
- "tile-texture": "tile-texture",
+ enhance: 'enhance',
+ anime: 'anime',
+ photographic: 'photographic',
+ 'digital-art': 'digital-art',
+ 'comic-book': 'comic-book',
+ 'fantasy-art': 'fantasy-art',
+ 'line-art': 'line-art',
+ 'analog-film': 'analog-film',
+ 'neon-punk': 'neon-punk',
+ isometric: 'isometric',
+ 'low-poly': 'low-poly',
+ origami: 'origami',
+ 'modeling-compound': 'modeling-compound',
+ cinematic: 'cinematic',
+ '3d-model': '3d-model',
+ 'pixel-art': 'pixel-art',
+ 'tile-texture': 'tile-texture',
} as const;
export type StabilityImageGenrationUltraBody = {
- /** Controls the aspect ratio of the generated image. */
- aspect_ratio?: StabilityImageGenrationUltraBodyAspectRatio;
- /** The image to use as the starting point for the generation. > **Important:** The `strength` parameter is required when `image` is provided. Supported Formats: - jpeg - png - webp Validation Rules: - Width must be between 64 and 16,384 pixels - Height must be between 64 and 16,384 pixels - Total pixel count must be at least 4,096 pixels */
- image?: Blob;
- /**
- * A blurb of text describing what you **do not** wish to see in the output image. This is an advanced feature.
- * @maxLength 10000
- */
- negative_prompt?: string;
- /** Dictates the `content-type` of the generated image. */
- output_format?: StabilityImageGenrationUltraBodyOutputFormat;
- /**
- * What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results. To control the weight of a given word use the format `(word:weight)`, where `word` is the word you'd like to control the weight of and `weight` is a value between 0 and 1. For example: `The sky was a crisp (blue:0.3) and (green:0.8)` would convey a sky that was blue and green, but more green than blue.
- * @minLength 1
- * @maxLength 10000
- */
- prompt: string;
- /**
- * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
- /**
+ /** Controls the aspect ratio of the generated image. */
+ aspect_ratio?: StabilityImageGenrationUltraBodyAspectRatio;
+ /** The image to use as the starting point for the generation. > **Important:** The `strength` parameter is required when `image` is provided. Supported Formats: - jpeg - png - webp Validation Rules: - Width must be between 64 and 16,384 pixels - Height must be between 64 and 16,384 pixels - Total pixel count must be at least 4,096 pixels */
+ image?: Blob;
+ /**
+ * A blurb of text describing what you **do not** wish to see in the output image. This is an advanced feature.
+ * @maxLength 10000
+ */
+ negative_prompt?: string;
+ /** Dictates the `content-type` of the generated image. */
+ output_format?: StabilityImageGenrationUltraBodyOutputFormat;
+ /**
+ * What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results. To control the weight of a given word use the format `(word:weight)`, where `word` is the word you'd like to control the weight of and `weight` is a value between 0 and 1. For example: `The sky was a crisp (blue:0.3) and (green:0.8)` would convey a sky that was blue and green, but more green than blue.
+ * @minLength 1
+ * @maxLength 10000
+ */
+ prompt: string;
+ /**
+ * A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
+ /**
* Sometimes referred to as _denoising_, this parameter controls how much influence the
`image` parameter has on the generated image. A value of 0 would yield an image that
is identical to the input. A value of 1 would be as if you passed in no image at all.
@@ -9916,649 +10029,610 @@ is identical to the input. A value of 1 would be as if you passed in no image a
* @minimum 0
* @maximum 1
*/
- strength?: number;
- /** Guides the image model towards a particular style. */
- style_preset?: StabilityImageGenrationUltraBodyStylePreset;
+ strength?: number;
+ /** Guides the image model towards a particular style. */
+ style_preset?: StabilityImageGenrationUltraBodyStylePreset;
};
/**
* The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.
*/
-export type StabilityImageGenrationUltra200OneFinishReason =
- (typeof StabilityImageGenrationUltra200OneFinishReason)[keyof typeof StabilityImageGenrationUltra200OneFinishReason];
+export type StabilityImageGenrationUltra200OneFinishReason = typeof StabilityImageGenrationUltra200OneFinishReason[keyof typeof StabilityImageGenrationUltra200OneFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltra200OneFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityImageGenrationUltra200One = {
- /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationUltra200OneFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
+ finish_reason: StabilityImageGenrationUltra200OneFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
/**
* The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.
*/
-export type StabilityImageGenrationUltra200TwoFinishReason =
- (typeof StabilityImageGenrationUltra200TwoFinishReason)[keyof typeof StabilityImageGenrationUltra200TwoFinishReason];
+export type StabilityImageGenrationUltra200TwoFinishReason = typeof StabilityImageGenrationUltra200TwoFinishReason[keyof typeof StabilityImageGenrationUltra200TwoFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltra200TwoFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityImageGenrationUltra200Two = {
- /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationUltra200TwoFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
+ finish_reason: StabilityImageGenrationUltra200TwoFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
/**
* The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.
*/
-export type StabilityImageGenrationUltra200ThreeFinishReason =
- (typeof StabilityImageGenrationUltra200ThreeFinishReason)[keyof typeof StabilityImageGenrationUltra200ThreeFinishReason];
+export type StabilityImageGenrationUltra200ThreeFinishReason = typeof StabilityImageGenrationUltra200ThreeFinishReason[keyof typeof StabilityImageGenrationUltra200ThreeFinishReason];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const StabilityImageGenrationUltra200ThreeFinishReason = {
- SUCCESS: "SUCCESS",
- CONTENT_FILTERED: "CONTENT_FILTERED",
+ SUCCESS: 'SUCCESS',
+ CONTENT_FILTERED: 'CONTENT_FILTERED',
} as const;
export type StabilityImageGenrationUltra200Three = {
- /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
- finish_reason: StabilityImageGenrationUltra200ThreeFinishReason;
- /** The generated image, encoded to base64. */
- image: string;
- /**
- * The seed used as random noise for this generation.
- * @minimum 0
- * @maximum 4294967294
- */
- seed?: number;
+ /** The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. */
+ finish_reason: StabilityImageGenrationUltra200ThreeFinishReason;
+ /** The generated image, encoded to base64. */
+ image: string;
+ /**
+ * The seed used as random noise for this generation.
+ * @minimum 0
+ * @maximum 4294967294
+ */
+ seed?: number;
};
export type StabilityImageGenrationUltra400 = {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
};
export type StabilityImageGenrationUltra413 = {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
};
export type StabilityImageGenrationUltra422 = {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
};
export type StabilityImageGenrationUltra429 = {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
};
export type StabilityImageGenrationUltra500 = {
- /**
- * One or more error messages indicating what went wrong.
- * @minItems 1
- */
- errors: string[];
- /**
- * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
- * @minLength 1
- */
- id: string;
- /**
- * Short-hand name for an error, useful for discriminating between errors with the same status code.
- * @minLength 1
- */
- name: string;
+ /**
+ * One or more error messages indicating what went wrong.
+ * @minItems 1
+ */
+ errors: string[];
+ /**
+ * A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.
+ * @minLength 1
+ */
+ id: string;
+ /**
+ * Short-hand name for an error, useful for discriminating between errors with the same status code.
+ * @minLength 1
+ */
+ name: string;
};
export type TripoCreateTaskBodyOneOf = {
- auto_size?: boolean;
- face_limit?: number;
- model_seed?: number;
- model_version?: TripoModelVersion;
- /** @maxLength 1024 */
- negative_prompt?: string;
- pbr?: boolean;
- /** @maxLength 1024 */
- prompt: string;
- quad?: boolean;
- style?: TripoModelStyle;
- text_seed?: number;
- texture?: boolean;
- texture_quality?: TripoTextureQuality;
- texture_seed?: number;
- type: TripoTextToModel;
+ auto_size?: boolean;
+ face_limit?: number;
+ model_seed?: number;
+ model_version?: TripoModelVersion;
+ /** @maxLength 1024 */
+ negative_prompt?: string;
+ pbr?: boolean;
+ /** @maxLength 1024 */
+ prompt: string;
+ quad?: boolean;
+ style?: TripoModelStyle;
+ text_seed?: number;
+ texture?: boolean;
+ texture_quality?: TripoTextureQuality;
+ texture_seed?: number;
+ type: TripoTextToModel;
};
export type TripoCreateTaskBodyOneOfTwoFile = {
- file_token: string;
- type: string;
+ file_token: string;
+ type: string;
};
export type TripoCreateTaskBodyOneOfTwo = {
- auto_size?: boolean;
- face_limit?: number;
- file: TripoCreateTaskBodyOneOfTwoFile;
- model_seed?: number;
- model_version?: TripoModelVersion;
- orientation?: TripoOrientation;
- pbr?: boolean;
- quad?: boolean;
- style?: TripoModelStyle;
- texture?: boolean;
- texture_alignment?: TripoTextureAlignment;
- texture_quality?: TripoTextureQuality;
- texture_seed?: number;
- type: TripoImageToModel;
+ auto_size?: boolean;
+ face_limit?: number;
+ file: TripoCreateTaskBodyOneOfTwoFile;
+ model_seed?: number;
+ model_version?: TripoModelVersion;
+ orientation?: TripoOrientation;
+ pbr?: boolean;
+ quad?: boolean;
+ style?: TripoModelStyle;
+ texture?: boolean;
+ texture_alignment?: TripoTextureAlignment;
+ texture_quality?: TripoTextureQuality;
+ texture_seed?: number;
+ type: TripoImageToModel;
};
export type TripoCreateTaskBodyOneOfFourFilesItem = {
- file_token: string;
- type: string;
+ file_token: string;
+ type: string;
};
export type TripoCreateTaskBodyOneOfFour = {
- auto_size?: boolean;
- face_limit?: number;
- files: TripoCreateTaskBodyOneOfFourFilesItem[];
- mode?: TripoMultiviewMode;
- model_seed?: number;
- model_version?: TripoModelVersion;
- orientation?: TripoOrientation;
- orthographic_projection?: boolean;
- pbr?: boolean;
- quad?: boolean;
- texture?: boolean;
- texture_alignment?: TripoTextureAlignment;
- texture_quality?: TripoTextureQuality;
- texture_seed?: number;
- type: TripoMultiviewToModel;
+ auto_size?: boolean;
+ face_limit?: number;
+ files: TripoCreateTaskBodyOneOfFourFilesItem[];
+ mode?: TripoMultiviewMode;
+ model_seed?: number;
+ model_version?: TripoModelVersion;
+ orientation?: TripoOrientation;
+ orthographic_projection?: boolean;
+ pbr?: boolean;
+ quad?: boolean;
+ texture?: boolean;
+ texture_alignment?: TripoTextureAlignment;
+ texture_quality?: TripoTextureQuality;
+ texture_seed?: number;
+ type: TripoMultiviewToModel;
};
export type TripoCreateTaskBodyOneOfSix = {
- model_seed?: number;
- original_model_task_id: string;
- pbr?: boolean;
- texture?: boolean;
- texture_alignment?: TripoTextureAlignment;
- texture_quality?: TripoTextureQuality;
- texture_seed?: number;
- type: TripoTypeTextureModel;
+ model_seed?: number;
+ original_model_task_id: string;
+ pbr?: boolean;
+ texture?: boolean;
+ texture_alignment?: TripoTextureAlignment;
+ texture_quality?: TripoTextureQuality;
+ texture_seed?: number;
+ type: TripoTypeTextureModel;
};
export type TripoCreateTaskBodyOneOfSeven = {
- draft_model_task_id: string;
- type: TripoTypeRefineModel;
+ draft_model_task_id: string;
+ type: TripoTypeRefineModel;
};
export type TripoCreateTaskBodyOneOfEight = {
- original_model_task_id: string;
- type: TripoTypeAnimatePrerigcheck;
+ original_model_task_id: string;
+ type: TripoTypeAnimatePrerigcheck;
};
export type TripoCreateTaskBodyOneOfNine = {
- original_model_task_id: string;
- out_format?: TripoStandardFormat;
- spec?: TripoSpec;
- topology?: TripoTopology;
- type: TripoTypeAnimateRig;
+ original_model_task_id: string;
+ out_format?: TripoStandardFormat;
+ spec?: TripoSpec;
+ topology?: TripoTopology;
+ type: TripoTypeAnimateRig;
};
export type TripoCreateTaskBodyOneOfOnezero = {
- animation: TripoAnimation;
- bake_animation?: boolean;
- original_model_task_id: string;
- out_format?: TripoStandardFormat;
- type: TripoTypeAnimateRetarget;
+ animation: TripoAnimation;
+ bake_animation?: boolean;
+ original_model_task_id: string;
+ out_format?: TripoStandardFormat;
+ type: TripoTypeAnimateRetarget;
};
export type TripoCreateTaskBodyOneOfOneone = {
- block_size?: number;
- original_model_task_id: string;
- style: TripoStylizeOptions;
- type: TripoTypeStylizeModel;
+ block_size?: number;
+ original_model_task_id: string;
+ style: TripoStylizeOptions;
+ type: TripoTypeStylizeModel;
};
export type TripoCreateTaskBodyOneOfOnetwo = {
- face_limit?: number;
- flatten_bottom?: boolean;
- flatten_bottom_threshold?: number;
- force_symmetry?: boolean;
- format: TripoConvertFormat;
- original_model_task_id: string;
- pivot_to_center_bottom?: boolean;
- quad?: boolean;
- texture_format?: TripoTextureFormat;
- texture_size?: number;
- type: TripoTypeConvertModel;
+ face_limit?: number;
+ flatten_bottom?: boolean;
+ flatten_bottom_threshold?: number;
+ force_symmetry?: boolean;
+ format: TripoConvertFormat;
+ original_model_task_id: string;
+ pivot_to_center_bottom?: boolean;
+ quad?: boolean;
+ texture_format?: TripoTextureFormat;
+ texture_size?: number;
+ type: TripoTypeConvertModel;
};
-export type TripoCreateTaskBody =
- | TripoCreateTaskBodyOneOf
- | TripoCreateTaskBodyOneOfTwo
- | TripoCreateTaskBodyOneOfFour
- | TripoCreateTaskBodyOneOfSix
- | TripoCreateTaskBodyOneOfSeven
- | TripoCreateTaskBodyOneOfEight
- | TripoCreateTaskBodyOneOfNine
- | TripoCreateTaskBodyOneOfOnezero
- | TripoCreateTaskBodyOneOfOneone
- | TripoCreateTaskBodyOneOfOnetwo;
+export type TripoCreateTaskBody = TripoCreateTaskBodyOneOf | TripoCreateTaskBodyOneOfTwo | TripoCreateTaskBodyOneOfFour | TripoCreateTaskBodyOneOfSix | TripoCreateTaskBodyOneOfSeven | TripoCreateTaskBodyOneOfEight | TripoCreateTaskBodyOneOfNine | TripoCreateTaskBodyOneOfOnezero | TripoCreateTaskBodyOneOfOneone | TripoCreateTaskBodyOneOfOnetwo;
export type TripoGetTask200 = {
- code: TripoResponseSuccessCode;
- data: TripoTask;
+ code: TripoResponseSuccessCode;
+ data: TripoTask;
};
export type TripoUploadFileBody = {
- file: Blob;
+ file: Blob;
};
export type TripoUploadFile200Data = {
- image_token: string;
+ image_token: string;
};
export type TripoUploadFile200 = {
- code: TripoResponseSuccessCode;
- data: TripoUploadFile200Data;
+ code: TripoResponseSuccessCode;
+ data: TripoUploadFile200Data;
};
export type TripoGetBalance200 = {
- code: TripoResponseSuccessCode;
- data: TripoBalance;
+ code: TripoResponseSuccessCode;
+ data: TripoBalance;
};
export type ValidatePublisherParams = {
- /**
- * The publisher username to validate.
- */
- username: string;
+/**
+ * The publisher username to validate.
+ */
+username: string;
};
export type ValidatePublisher200 = {
- /** True if the username is available, false otherwise. */
- isAvailable?: boolean;
+ /** True if the username is available, false otherwise. */
+ isAvailable?: boolean;
};
export type ListNodesForPublisherParams = {
- /**
- * Number of nodes to return per page
- */
- include_banned?: boolean;
+/**
+ * Number of nodes to return per page
+ */
+include_banned?: boolean;
};
export type ListNodesForPublisherV2Params = {
- /**
- * Number of nodes to return per page
- */
- include_banned?: boolean;
- /**
- * Page number of the nodes list
- */
- page?: number;
- /**
- * Number of nodes to return per page
- */
- limit?: number;
+/**
+ * Number of nodes to return per page
+ */
+include_banned?: boolean;
+/**
+ * Page number of the nodes list
+ */
+page?: number;
+/**
+ * Number of nodes to return per page
+ */
+limit?: number;
};
export type ListNodesForPublisherV2200 = {
- /** Maximum number of nodes per page */
- limit?: number;
- nodes?: Node[];
- /** Current page number */
- page?: number;
- /** Total number of nodes available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
+ /** Maximum number of nodes per page */
+ limit?: number;
+ nodes?: Node[];
+ /** Current page number */
+ page?: number;
+ /** Total number of nodes available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
};
export type GetPermissionOnPublisherNodes200 = {
- canEdit?: boolean;
+ canEdit?: boolean;
};
export type PublishNodeVersionBody = {
- node: Node;
- node_version: NodeVersion;
- personal_access_token: string;
+ node: Node;
+ node_version: NodeVersion;
+ personal_access_token: string;
};
export type PublishNodeVersion201 = {
- node_version?: NodeVersion;
- /** The signed URL to upload the node version token. */
- signedUrl?: string;
+ node_version?: NodeVersion;
+ /** The signed URL to upload the node version token. */
+ signedUrl?: string;
};
export type GetPermissionOnPublisher200 = {
- canEdit?: boolean;
+ canEdit?: boolean;
};
export type CreatePersonalAccessToken201 = {
- /** The newly created personal access token. */
- token?: string;
+ /** The newly created personal access token. */
+ token?: string;
};
export type GetReleaseNotesParams = {
- /**
- * The project to get release notes for
- */
- project: GetReleaseNotesProject;
- /**
- * The current version to filter release notes
- */
- current_version?: string;
- /**
- * The locale for the release notes
- */
- locale?: GetReleaseNotesLocale;
- /**
- * The platform requesting the release notes
- */
- form_factor?: string;
+/**
+ * The project to get release notes for
+ */
+project: GetReleaseNotesProject;
+/**
+ * The current version to filter release notes
+ */
+current_version?: string;
+/**
+ * The locale for the release notes
+ */
+locale?: GetReleaseNotesLocale;
+/**
+ * The platform requesting the release notes
+ */
+form_factor?: string;
};
-export type GetReleaseNotesProject =
- (typeof GetReleaseNotesProject)[keyof typeof GetReleaseNotesProject];
+export type GetReleaseNotesProject = typeof GetReleaseNotesProject[keyof typeof GetReleaseNotesProject];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetReleaseNotesProject = {
- comfyui: "comfyui",
- comfyui_frontend: "comfyui_frontend",
- desktop: "desktop",
+ comfyui: 'comfyui',
+ comfyui_frontend: 'comfyui_frontend',
+ desktop: 'desktop',
} as const;
-export type GetReleaseNotesLocale =
- (typeof GetReleaseNotesLocale)[keyof typeof GetReleaseNotesLocale];
+export type GetReleaseNotesLocale = typeof GetReleaseNotesLocale[keyof typeof GetReleaseNotesLocale];
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetReleaseNotesLocale = {
- en: "en",
- es: "es",
- fr: "fr",
- ja: "ja",
- ko: "ko",
- ru: "ru",
- zh: "zh",
+ en: 'en',
+ es: 'es',
+ fr: 'fr',
+ ja: 'ja',
+ ko: 'ko',
+ ru: 'ru',
+ zh: 'zh',
} as const;
export type SecurityScanParams = {
- minAge?: string;
- minSecurityScanAge?: string;
- maxNodes?: number;
+minAge?: string;
+minSecurityScanAge?: string;
+maxNodes?: number;
};
export type PostUploadArtifactBody = {
- /** The author of the commit */
- author: string;
- /** The average amount of VRAM used in the run. */
- avg_vram?: number;
- branch_name: string;
- /** The name of the bucket where the output files are stored */
- bucket_name?: string;
- /** The path to ComfyUI logs. eg. gs://bucket-name/logs */
- comfy_logs_gcs_path?: string;
- /** The flags used in the comfy run */
- comfy_run_flags?: string;
- commit_hash: string;
- /** The commit message */
- commit_message: string;
- /** The time of the commit in the format of "YYYY-MM-DDTHH:MM:SSZ" (2016-10-10T00:00:00Z) */
- commit_time: string;
- /** Cuda version. */
- cuda_version?: string;
- /** The end time of the job as a Unix timestamp. */
- end_time: number;
- /** Unique identifier for the job */
- job_id: string;
- /** The user who triggered the job */
- job_trigger_user: string;
- machine_stats?: MachineStats;
- /** Operating system used in the run */
- os: string;
- /** A comma separated string that contains GCS path(s) to output files. eg. gs://bucket-name/output, gs://bucket-name/output2 */
- output_files_gcs_paths?: string;
- /** The peak amount of VRAM used in the run. */
- peak_vram?: number;
- /** The pull request number */
- pr_number: string;
- /** The python version used in the run */
- python_version: string;
- /** The pytorch version used in the run */
- pytorch_version?: string;
- /** Repository name */
- repo: string;
- /** Unique identifier for the run */
- run_id: string;
- /** The start time of the job as a Unix timestamp. */
- start_time: number;
- status: WorkflowRunStatus;
- /** The name of the workflow */
- workflow_name: string;
+ /** The author of the commit */
+ author: string;
+ /** The average amount of VRAM used in the run. */
+ avg_vram?: number;
+ branch_name: string;
+ /** The name of the bucket where the output files are stored */
+ bucket_name?: string;
+ /** The path to ComfyUI logs. eg. gs://bucket-name/logs */
+ comfy_logs_gcs_path?: string;
+ /** The flags used in the comfy run */
+ comfy_run_flags?: string;
+ commit_hash: string;
+ /** The commit message */
+ commit_message: string;
+ /** The time of the commit in the format of "YYYY-MM-DDTHH:MM:SSZ" (2016-10-10T00:00:00Z) */
+ commit_time: string;
+ /** Cuda version. */
+ cuda_version?: string;
+ /** The end time of the job as a Unix timestamp. */
+ end_time: number;
+ /** Unique identifier for the job */
+ job_id: string;
+ /** The user who triggered the job */
+ job_trigger_user: string;
+ machine_stats?: MachineStats;
+ /** Operating system used in the run */
+ os: string;
+ /** A comma separated string that contains GCS path(s) to output files. eg. gs://bucket-name/output, gs://bucket-name/output2 */
+ output_files_gcs_paths?: string;
+ /** The peak amount of VRAM used in the run. */
+ peak_vram?: number;
+ /** The pull request number */
+ pr_number: string;
+ /** The python version used in the run */
+ python_version: string;
+ /** The pytorch version used in the run */
+ pytorch_version?: string;
+ /** Repository name */
+ repo: string;
+ /** Unique identifier for the run */
+ run_id: string;
+ /** The start time of the job as a Unix timestamp. */
+ start_time: number;
+ status: WorkflowRunStatus;
+ /** The name of the workflow */
+ workflow_name: string;
};
export type PostUploadArtifact200 = {
- message?: string;
+ message?: string;
};
export type ListAllNodeVersionsParams = {
- nodeId?: string;
- statuses?: NodeVersionStatus[];
- include_status_reason?: boolean;
- /**
- * The page number to retrieve.
- */
- page?: number;
- /**
- * The number of items to include per page.
- */
- pageSize?: number;
- /**
- * search for status_reason, case insensitive
- */
- status_reason?: string;
+nodeId?: string;
+statuses?: NodeVersionStatus[];
+include_status_reason?: boolean;
+/**
+ * The page number to retrieve.
+ */
+page?: number;
+/**
+ * The number of items to include per page.
+ */
+pageSize?: number;
+/**
+ * search for status_reason, case insensitive
+ */
+status_reason?: string;
};
export type ListAllNodeVersions200 = {
- /** Current page number */
- page?: number;
- /** Maximum number of node versions per page. Maximum is 100. */
- pageSize?: number;
- /** Total number of node versions available */
- total?: number;
- /** Total number of pages available */
- totalPages?: number;
- versions?: NodeVersion[];
+ /** Current page number */
+ page?: number;
+ /** Maximum number of node versions per page. Maximum is 100. */
+ pageSize?: number;
+ /** Total number of node versions available */
+ total?: number;
+ /** Total number of pages available */
+ totalPages?: number;
+ versions?: NodeVersion[];
};
export type MetronomeZeroBalanceBodyProperties = {
- /** the metronome customer id */
- customer_id?: string;
- /** the customer remaining balance */
- remaining_balance?: number;
+ /** the metronome customer id */
+ customer_id?: string;
+ /** the customer remaining balance */
+ remaining_balance?: number;
};
export type MetronomeZeroBalanceBody = {
- /** the id of the webhook */
- id: string;
- properties: MetronomeZeroBalanceBodyProperties;
- /** the type of the webhook */
- type: string;
+ /** the id of the webhook */
+ id: string;
+ properties: MetronomeZeroBalanceBodyProperties;
+ /** the type of the webhook */
+ type: string;
};
type SecondParameter unknown> = Parameters[1];
+
+
/**
* @summary Create a new custom node using admin priviledge
*/
export const adminCreateNode = (
node: Node,
- options?: SecondParameter,
- signal?: AbortSignal,
+ options?: SecondParameter,signal?: AbortSignal
) => {
- return customInstance(
- {
- url: `/admin/nodes`,
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: node,
- signal,
- },
- options,
- );
-};
+
+
+ return customInstance(
+ {url: `/admin/nodes`, method: 'POST',
+ headers: {'Content-Type': 'application/json', },
+ data: node, signal
+ },
+ options);
+ }
+
-export const getAdminCreateNodeMutationOptions = <
- TError = ErrorResponse | void | ErrorResponse | ErrorResponse,
- TContext = unknown,
->(options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { data: Node },
- TContext
- >;
- request?: SecondParameter;
-}): UseMutationOptions<
- Awaited>,
- TError,
- { data: Node },
- TContext
-> => {
- const mutationKey = ["adminCreateNode"];
- const { mutation: mutationOptions, request: requestOptions } = options
- ? options.mutation &&
- "mutationKey" in options.mutation &&
- options.mutation.mutationKey
- ? options
- : { ...options, mutation: { ...options.mutation, mutationKey } }
- : { mutation: { mutationKey }, request: undefined };
-
- const mutationFn: MutationFunction<
- Awaited>,
- { data: Node }
- > = (props) => {
- const { data } = props ?? {};
- return adminCreateNode(data, requestOptions);
- };
+export const getAdminCreateNodeMutationOptions = (options?: { mutation?:UseMutationOptions>, TError,{data: Node}, TContext>, request?: SecondParameter}
+): UseMutationOptions>, TError,{data: Node}, TContext> => {
- return { mutationFn, ...mutationOptions };
-};
+const mutationKey = ['adminCreateNode'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+ options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+ options
+ : {...options, mutation: {...options.mutation, mutationKey}}
+ : {mutation: { mutationKey, }, request: undefined};
-export type AdminCreateNodeMutationResult = NonNullable<
- Awaited>
->;
-export type AdminCreateNodeMutationBody = Node;
-export type AdminCreateNodeMutationError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse;
+
-/**
+
+ const mutationFn: MutationFunction>, {data: Node}> = (props) => {
+ const {data} = props ?? {};
+
+ return adminCreateNode(data,requestOptions)
+ }
+
+
+
+
+ return { mutationFn, ...mutationOptions }}
+
+ export type AdminCreateNodeMutationResult = NonNullable>>
+ export type AdminCreateNodeMutationBody = Node
+ export type AdminCreateNodeMutationError = ErrorResponse | void | ErrorResponse | ErrorResponse
+
+ /**
* @summary Create a new custom node using admin priviledge
*/
-export const useAdminCreateNode = <
- TError = ErrorResponse | void | ErrorResponse | ErrorResponse,
- TContext = unknown,
->(
- options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { data: Node },
- TContext
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseMutationResult<
- Awaited>,
- TError,
- { data: Node },
- TContext
-> => {
- const mutationOptions = getAdminCreateNodeMutationOptions(options);
-
- return useMutation(mutationOptions, queryClient);
-};
+export const useAdminCreateNode = (options?: { mutation?:UseMutationOptions>, TError,{data: Node}, TContext>, request?: SecondParameter}
+ , queryClient?: QueryClient): UseMutationResult<
+ Awaited>,
+ TError,
+ {data: Node},
+ TContext
+ > => {
+ const mutationOptions = getAdminCreateNodeMutationOptions(options);
+
+ return useMutation(mutationOptions, queryClient);
+ }
+
/**
* Only admins can update a node with admin privileges.
* @summary Admin Update Node
@@ -10566,106 +10640,65 @@ export const useAdminCreateNode = <
export const adminUpdateNode = (
nodeId: string,
node: Node,
- options?: SecondParameter,
-) => {
- return customInstance(
- {
- url: `/admin/nodes/${nodeId}`,
- method: "PUT",
- headers: { "Content-Type": "application/json" },
- data: node,
- },
- options,
- );
-};
+ options?: SecondParameter,) => {
+
+
+ return customInstance(
+ {url: `/admin/nodes/${nodeId}`, method: 'PUT',
+ headers: {'Content-Type': 'application/json', },
+ data: node
+ },
+ options);
+ }
+
-export const getAdminUpdateNodeMutationOptions = <
- TError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse,
- TContext = unknown,
->(options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { nodeId: string; data: Node },
- TContext
- >;
- request?: SecondParameter;
-}): UseMutationOptions<
- Awaited>,
- TError,
- { nodeId: string; data: Node },
- TContext
-> => {
- const mutationKey = ["adminUpdateNode"];
- const { mutation: mutationOptions, request: requestOptions } = options
- ? options.mutation &&
- "mutationKey" in options.mutation &&
- options.mutation.mutationKey
- ? options
- : { ...options, mutation: { ...options.mutation, mutationKey } }
- : { mutation: { mutationKey }, request: undefined };
-
- const mutationFn: MutationFunction<
- Awaited>,
- { nodeId: string; data: Node }
- > = (props) => {
- const { nodeId, data } = props ?? {};
- return adminUpdateNode(nodeId, data, requestOptions);
- };
+export const getAdminUpdateNodeMutationOptions = (options?: { mutation?:UseMutationOptions>, TError,{nodeId: string;data: Node}, TContext>, request?: SecondParameter}
+): UseMutationOptions>, TError,{nodeId: string;data: Node}, TContext> => {
- return { mutationFn, ...mutationOptions };
-};
+const mutationKey = ['adminUpdateNode'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+ options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+ options
+ : {...options, mutation: {...options.mutation, mutationKey}}
+ : {mutation: { mutationKey, }, request: undefined};
-export type AdminUpdateNodeMutationResult = NonNullable<
- Awaited>
->;
-export type AdminUpdateNodeMutationBody = Node;
-export type AdminUpdateNodeMutationError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse;
+
-/**
+
+ const mutationFn: MutationFunction>, {nodeId: string;data: Node}> = (props) => {
+ const {nodeId,data} = props ?? {};
+
+ return adminUpdateNode(nodeId,data,requestOptions)
+ }
+
+
+
+
+ return { mutationFn, ...mutationOptions }}
+
+ export type AdminUpdateNodeMutationResult = NonNullable>>
+ export type AdminUpdateNodeMutationBody = Node
+ export type AdminUpdateNodeMutationError = ErrorResponse | void | ErrorResponse | ErrorResponse | ErrorResponse
+
+ /**
* @summary Admin Update Node
*/
-export const useAdminUpdateNode = <
- TError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse,
- TContext = unknown,
->(
- options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { nodeId: string; data: Node },
- TContext
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseMutationResult<
- Awaited>,
- TError,
- { nodeId: string; data: Node },
- TContext
-> => {
- const mutationOptions = getAdminUpdateNodeMutationOptions(options);
-
- return useMutation(mutationOptions, queryClient);
-};
+export const useAdminUpdateNode = (options?: { mutation?:UseMutationOptions>, TError,{nodeId: string;data: Node}, TContext>, request?: SecondParameter}
+ , queryClient?: QueryClient): UseMutationResult<
+ Awaited>,
+ TError,
+ {nodeId: string;data: Node},
+ TContext
+ > => {
+
+ const mutationOptions = getAdminUpdateNodeMutationOptions(options);
+ return useMutation(mutationOptions, queryClient);
+ }
+
/**
* Only admins can approve a node version.
* @summary Admin Update Node Version Status
@@ -10674,3601 +10707,2282 @@ export const adminUpdateNodeVersion = (
nodeId: string,
versionNumber: string,
adminUpdateNodeVersionBody: AdminUpdateNodeVersionBody,
- options?: SecondParameter,
-) => {
- return customInstance(
- {
- url: `/admin/nodes/${nodeId}/versions/${versionNumber}`,
- method: "PUT",
- headers: { "Content-Type": "application/json" },
- data: adminUpdateNodeVersionBody,
- },
- options,
- );
-};
+ options?: SecondParameter,) => {
+
+
+ return customInstance(
+ {url: `/admin/nodes/${nodeId}/versions/${versionNumber}`, method: 'PUT',
+ headers: {'Content-Type': 'application/json', },
+ data: adminUpdateNodeVersionBody
+ },
+ options);
+ }
+
-export const getAdminUpdateNodeVersionMutationOptions = <
- TError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse,
- TContext = unknown,
->(options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- {
- nodeId: string;
- versionNumber: string;
- data: AdminUpdateNodeVersionBody;
- },
- TContext
- >;
- request?: SecondParameter;
-}): UseMutationOptions<
- Awaited>,
- TError,
- { nodeId: string; versionNumber: string; data: AdminUpdateNodeVersionBody },
- TContext
-> => {
- const mutationKey = ["adminUpdateNodeVersion"];
- const { mutation: mutationOptions, request: requestOptions } = options
- ? options.mutation &&
- "mutationKey" in options.mutation &&
- options.mutation.mutationKey
- ? options
- : { ...options, mutation: { ...options.mutation, mutationKey } }
- : { mutation: { mutationKey }, request: undefined };
-
- const mutationFn: MutationFunction<
- Awaited>,
- {
- nodeId: string;
- versionNumber: string;
- data: AdminUpdateNodeVersionBody;
+
+export const getAdminUpdateNodeVersionMutationOptions = (options?: { mutation?:UseMutationOptions>, TError,{nodeId: string;versionNumber: string;data: AdminUpdateNodeVersionBody}, TContext>, request?: SecondParameter}
+): UseMutationOptions>, TError,{nodeId: string;versionNumber: string;data: AdminUpdateNodeVersionBody}, TContext> => {
+
+const mutationKey = ['adminUpdateNodeVersion'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+ options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+ options
+ : {...options, mutation: {...options.mutation, mutationKey}}
+ : {mutation: { mutationKey, }, request: undefined};
+
+
+
+
+ const mutationFn: MutationFunction>, {nodeId: string;versionNumber: string;data: AdminUpdateNodeVersionBody}> = (props) => {
+ const {nodeId,versionNumber,data} = props ?? {};
+
+ return adminUpdateNodeVersion(nodeId,versionNumber,data,requestOptions)
}
- > = (props) => {
- const { nodeId, versionNumber, data } = props ?? {};
-
- return adminUpdateNodeVersion(
- nodeId,
- versionNumber,
- data,
- requestOptions,
- );
- };
-
- return { mutationFn, ...mutationOptions };
-};
-export type AdminUpdateNodeVersionMutationResult = NonNullable<
- Awaited>
->;
-export type AdminUpdateNodeVersionMutationBody = AdminUpdateNodeVersionBody;
-export type AdminUpdateNodeVersionMutationError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse;
+
-/**
+
+ return { mutationFn, ...mutationOptions }}
+
+ export type AdminUpdateNodeVersionMutationResult = NonNullable>>
+ export type AdminUpdateNodeVersionMutationBody = AdminUpdateNodeVersionBody
+ export type AdminUpdateNodeVersionMutationError = ErrorResponse | void | ErrorResponse | ErrorResponse | ErrorResponse
+
+ /**
* @summary Admin Update Node Version Status
*/
-export const useAdminUpdateNodeVersion = <
- TError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse
- | ErrorResponse,
- TContext = unknown,
->(
- options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- {
- nodeId: string;
- versionNumber: string;
- data: AdminUpdateNodeVersionBody;
- },
- TContext
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseMutationResult<
- Awaited>,
- TError,
- { nodeId: string; versionNumber: string; data: AdminUpdateNodeVersionBody },
- TContext
-> => {
- const mutationOptions = getAdminUpdateNodeVersionMutationOptions(options);
-
- return useMutation(mutationOptions, queryClient);
-};
+export const useAdminUpdateNodeVersion = (options?: { mutation?:UseMutationOptions>, TError,{nodeId: string;versionNumber: string;data: AdminUpdateNodeVersionBody}, TContext>, request?: SecondParameter}
+ , queryClient?: QueryClient): UseMutationResult<
+ Awaited>,
+ TError,
+ {nodeId: string;versionNumber: string;data: AdminUpdateNodeVersionBody},
+ TContext
+ > => {
+
+ const mutationOptions = getAdminUpdateNodeVersionMutationOptions(options);
+ return useMutation(mutationOptions, queryClient);
+ }
+
/**
* Returns all branches for a given repo.
* @summary Retrieve all distinct branches for a given repo
*/
export const getBranch = (
params: GetBranchParams,
- options?: SecondParameter,
- signal?: AbortSignal,
+ options?: SecondParameter,signal?: AbortSignal
) => {
- return customInstance(
- { url: `/branch`, method: "GET", params, signal },
- options,
- );
-};
+
+
+ return customInstance(
+ {url: `/branch`, method: 'GET',
+ params, signal
+ },
+ options);
+ }
+
-export const getGetBranchQueryKey = (params?: GetBranchParams) => {
- return [`/branch`, ...(params ? [params] : [])] as const;
-};
-export const getGetBranchQueryOptions = <
- TData = Awaited>,
- TError = void | void,
->(
- params: GetBranchParams,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- >;
- request?: SecondParameter;
- },
+
+export const getGetBranchQueryKey = (params?: GetBranchParams,) => {
+ return [
+ `/branch`, ...(params ? [params]: [])
+ ] as const;
+ }
+
+
+export const getGetBranchQueryOptions = >, TError = void | void>(params: GetBranchParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
) => {
- const { query: queryOptions, request: requestOptions } = options ?? {};
- const queryKey = queryOptions?.queryKey ?? getGetBranchQueryKey(params);
+const {query: queryOptions, request: requestOptions} = options ?? {};
- const queryFn: QueryFunction>> = ({
- signal,
- }) => getBranch(params, requestOptions, signal);
+ const queryKey = queryOptions?.queryKey ?? getGetBranchQueryKey(params);
- return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
- Awaited>,
- TError,
- TData
- > & { queryKey: DataTag };
-};
+
-export type GetBranchQueryResult = NonNullable<
- Awaited>
->;
-export type GetBranchQueryError = void | void;
+ const queryFn: QueryFunction>> = ({ signal }) => getBranch(params, requestOptions, signal);
-export function useGetBranch<
- TData = Awaited>,
- TError = void | void,
->(
- params: GetBranchParams,
- options: {
- query: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- > &
- Pick<
- DefinedInitialDataOptions<
- Awaited>,
- TError,
- Awaited>
- >,
- "initialData"
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): DefinedUseQueryResult & {
- queryKey: DataTag;
-};
-export function useGetBranch<
- TData = Awaited>,
- TError = void | void,
->(
- params: GetBranchParams,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- > &
- Pick<
- UndefinedInitialDataOptions<
- Awaited>,
- TError,
- Awaited>
- >,
- "initialData"
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseQueryResult & {
- queryKey: DataTag;
-};
-export function useGetBranch<
- TData = Awaited>,
- TError = void | void,
->(
- params: GetBranchParams,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseQueryResult & {
- queryKey: DataTag;
-};
+
+
+
+
+ return { queryKey, queryFn, ...queryOptions} as UseQueryOptions>, TError, TData> & { queryKey: DataTag }
+}
+
+export type GetBranchQueryResult = NonNullable>>
+export type GetBranchQueryError = void | void
+
+
+export function useGetBranch>, TError = void | void>(
+ params: GetBranchParams, options: { query:Partial>, TError, TData>> & Pick<
+ DefinedInitialDataOptions<
+ Awaited>,
+ TError,
+ Awaited>
+ > , 'initialData'
+ >, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): DefinedUseQueryResult & { queryKey: DataTag }
+export function useGetBranch>, TError = void | void>(
+ params: GetBranchParams, options?: { query?:Partial>, TError, TData>> & Pick<
+ UndefinedInitialDataOptions<
+ Awaited>,
+ TError,
+ Awaited>
+ > , 'initialData'
+ >, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag }
+export function useGetBranch>, TError = void | void>(
+ params: GetBranchParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag }
/**
* @summary Retrieve all distinct branches for a given repo
*/
-export function useGetBranch<
- TData = Awaited>,
- TError = void | void,
->(
- params: GetBranchParams,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseQueryResult & {
- queryKey: DataTag;
-} {
- const queryOptions = getGetBranchQueryOptions(params, options);
+export function useGetBranch>, TError = void | void>(
+ params: GetBranchParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag } {
+
+ const queryOptions = getGetBranchQueryOptions(params,options)
- const query = useQuery(queryOptions, queryClient) as UseQueryResult<
- TData,
- TError
- > & { queryKey: DataTag };
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult & { queryKey: DataTag };
- query.queryKey = queryOptions.queryKey;
+ query.queryKey = queryOptions.queryKey ;
- return query;
+ return query;
}
+
+
+
/**
* @summary Retrieve multiple node versions in a single request
*/
export const getBulkNodeVersions = (
bulkNodeVersionsRequest: BulkNodeVersionsRequest,
- options?: SecondParameter,
- signal?: AbortSignal,
+ options?: SecondParameter,signal?: AbortSignal
) => {
- return customInstance(
- {
- url: `/bulk/nodes/versions`,
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: bulkNodeVersionsRequest,
- signal,
- },
- options,
- );
-};
+
+
+ return customInstance(
+ {url: `/bulk/nodes/versions`, method: 'POST',
+ headers: {'Content-Type': 'application/json', },
+ data: bulkNodeVersionsRequest, signal
+ },
+ options);
+ }
+
-export const getGetBulkNodeVersionsMutationOptions = <
- TError = ErrorResponse | ErrorResponse,
- TContext = unknown,
->(options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { data: BulkNodeVersionsRequest },
- TContext
- >;
- request?: SecondParameter;
-}): UseMutationOptions<
- Awaited>,
- TError,
- { data: BulkNodeVersionsRequest },
- TContext
-> => {
- const mutationKey = ["getBulkNodeVersions"];
- const { mutation: mutationOptions, request: requestOptions } = options
- ? options.mutation &&
- "mutationKey" in options.mutation &&
- options.mutation.mutationKey
- ? options
- : { ...options, mutation: { ...options.mutation, mutationKey } }
- : { mutation: { mutationKey }, request: undefined };
-
- const mutationFn: MutationFunction<
- Awaited>,
- { data: BulkNodeVersionsRequest }
- > = (props) => {
- const { data } = props ?? {};
- return getBulkNodeVersions(data, requestOptions);
- };
+export const getGetBulkNodeVersionsMutationOptions = (options?: { mutation?:UseMutationOptions>, TError,{data: BulkNodeVersionsRequest}, TContext>, request?: SecondParameter}
+): UseMutationOptions>, TError,{data: BulkNodeVersionsRequest}, TContext> => {
- return { mutationFn, ...mutationOptions };
-};
+const mutationKey = ['getBulkNodeVersions'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+ options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+ options
+ : {...options, mutation: {...options.mutation, mutationKey}}
+ : {mutation: { mutationKey, }, request: undefined};
-export type GetBulkNodeVersionsMutationResult = NonNullable<
- Awaited>
->;
-export type GetBulkNodeVersionsMutationBody = BulkNodeVersionsRequest;
-export type GetBulkNodeVersionsMutationError = ErrorResponse | ErrorResponse;
+
-/**
+
+ const mutationFn: MutationFunction>, {data: BulkNodeVersionsRequest}> = (props) => {
+ const {data} = props ?? {};
+
+ return getBulkNodeVersions(data,requestOptions)
+ }
+
+
+
+
+ return { mutationFn, ...mutationOptions }}
+
+ export type GetBulkNodeVersionsMutationResult = NonNullable>>
+ export type GetBulkNodeVersionsMutationBody = BulkNodeVersionsRequest
+ export type GetBulkNodeVersionsMutationError = ErrorResponse | ErrorResponse
+
+ /**
* @summary Retrieve multiple node versions in a single request
*/
-export const useGetBulkNodeVersions = <
- TError = ErrorResponse | ErrorResponse,
- TContext = unknown,
->(
- options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { data: BulkNodeVersionsRequest },
- TContext
- >;
- request?: SecondParameter;
+export const useGetBulkNodeVersions = (options?: { mutation?:UseMutationOptions>, TError,{data: BulkNodeVersionsRequest}, TContext>, request?: SecondParameter}
+ , queryClient?: QueryClient): UseMutationResult<
+ Awaited>,
+ TError,
+ {data: BulkNodeVersionsRequest},
+ TContext
+ > => {
+
+ const mutationOptions = getGetBulkNodeVersionsMutationOptions(options);
+
+ return useMutation(mutationOptions, queryClient);
+ }
+
+/**
+ * @summary list all comfy-nodes
+ */
+export const listAllComfyNodes = (
+ params?: ListAllComfyNodesParams,
+ options?: SecondParameter,signal?: AbortSignal
+) => {
+
+
+ return customInstance(
+ {url: `/comfy-nodes`, method: 'GET',
+ params, signal
},
- queryClient?: QueryClient,
-): UseMutationResult<
- Awaited>,
- TError,
- { data: BulkNodeVersionsRequest },
- TContext
-> => {
- const mutationOptions = getGetBulkNodeVersionsMutationOptions(options);
-
- return useMutation(mutationOptions, queryClient);
-};
+ options);
+ }
+
+
+
+
+export const getListAllComfyNodesQueryKey = (params?: ListAllComfyNodesParams,) => {
+ return [
+ `/comfy-nodes`, ...(params ? [params]: [])
+ ] as const;
+ }
+
+
+export const getListAllComfyNodesQueryOptions = >, TError = ErrorResponse | void | ErrorResponse | ErrorResponse>(params?: ListAllComfyNodesParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+ const queryKey = queryOptions?.queryKey ?? getListAllComfyNodesQueryKey(params);
+
+
+
+ const queryFn: QueryFunction>> = ({ signal }) => listAllComfyNodes(params, requestOptions, signal);
+
+
+
+
+
+ return { queryKey, queryFn, ...queryOptions} as UseQueryOptions>, TError, TData> & { queryKey: DataTag }
+}
+
+export type ListAllComfyNodesQueryResult = NonNullable>>
+export type ListAllComfyNodesQueryError = ErrorResponse | void | ErrorResponse | ErrorResponse
+
+
+export function useListAllComfyNodes>, TError = ErrorResponse | void | ErrorResponse | ErrorResponse>(
+ params: undefined | ListAllComfyNodesParams, options: { query:Partial>, TError, TData>> & Pick<
+ DefinedInitialDataOptions<
+ Awaited>,
+ TError,
+ Awaited>
+ > , 'initialData'
+ >, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): DefinedUseQueryResult & { queryKey: DataTag }
+export function useListAllComfyNodes>, TError = ErrorResponse | void | ErrorResponse | ErrorResponse>(
+ params?: ListAllComfyNodesParams, options?: { query?:Partial>, TError, TData>> & Pick<
+ UndefinedInitialDataOptions<
+ Awaited>,
+ TError,
+ Awaited>
+ > , 'initialData'
+ >, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag }
+export function useListAllComfyNodes>, TError = ErrorResponse | void | ErrorResponse | ErrorResponse>(
+ params?: ListAllComfyNodesParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag }
+/**
+ * @summary list all comfy-nodes
+ */
+
+export function useListAllComfyNodes>, TError = ErrorResponse | void | ErrorResponse | ErrorResponse>(
+ params?: ListAllComfyNodesParams, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
+ , queryClient?: QueryClient
+ ): UseQueryResult & { queryKey: DataTag } {
+
+ const queryOptions = getListAllComfyNodesQueryOptions(params,options)
+
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult & { queryKey: DataTag };
+
+ query.queryKey = queryOptions.queryKey ;
+
+ return query;
+}
+
+
+
/**
* @summary trigger comfy nodes backfill
*/
export const comfyNodesBackfill = (
params?: ComfyNodesBackfillParams,
- options?: SecondParameter,
- signal?: AbortSignal,
+ options?: SecondParameter,signal?: AbortSignal
) => {
- return customInstance(
- { url: `/comfy-nodes/backfill`, method: "POST", params, signal },
- options,
- );
-};
+
+
+ return customInstance(
+ {url: `/comfy-nodes/backfill`, method: 'POST',
+ params, signal
+ },
+ options);
+ }
+
-export const getComfyNodesBackfillMutationOptions = <
- TError = ErrorResponse | void | ErrorResponse | ErrorResponse,
- TContext = unknown,
->(options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { params?: ComfyNodesBackfillParams },
- TContext
- >;
- request?: SecondParameter;
-}): UseMutationOptions<
- Awaited>,
- TError,
- { params?: ComfyNodesBackfillParams },
- TContext
-> => {
- const mutationKey = ["comfyNodesBackfill"];
- const { mutation: mutationOptions, request: requestOptions } = options
- ? options.mutation &&
- "mutationKey" in options.mutation &&
- options.mutation.mutationKey
- ? options
- : { ...options, mutation: { ...options.mutation, mutationKey } }
- : { mutation: { mutationKey }, request: undefined };
-
- const mutationFn: MutationFunction<
- Awaited>,
- { params?: ComfyNodesBackfillParams }
- > = (props) => {
- const { params } = props ?? {};
- return comfyNodesBackfill(params, requestOptions);
- };
+export const getComfyNodesBackfillMutationOptions = (options?: { mutation?:UseMutationOptions>, TError,{params?: ComfyNodesBackfillParams}, TContext>, request?: SecondParameter}
+): UseMutationOptions>, TError,{params?: ComfyNodesBackfillParams}, TContext> => {
- return { mutationFn, ...mutationOptions };
-};
+const mutationKey = ['comfyNodesBackfill'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+ options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+ options
+ : {...options, mutation: {...options.mutation, mutationKey}}
+ : {mutation: { mutationKey, }, request: undefined};
-export type ComfyNodesBackfillMutationResult = NonNullable<
- Awaited>
->;
+
-export type ComfyNodesBackfillMutationError =
- | ErrorResponse
- | void
- | ErrorResponse
- | ErrorResponse;
-/**
+ const mutationFn: MutationFunction>, {params?: ComfyNodesBackfillParams}> = (props) => {
+ const {params} = props ?? {};
+
+ return comfyNodesBackfill(params,requestOptions)
+ }
+
+
+
+
+ return { mutationFn, ...mutationOptions }}
+
+ export type ComfyNodesBackfillMutationResult = NonNullable>>
+
+ export type ComfyNodesBackfillMutationError = ErrorResponse | void | ErrorResponse | ErrorResponse
+
+ /**
* @summary trigger comfy nodes backfill
*/
-export const useComfyNodesBackfill = <
- TError = ErrorResponse | void | ErrorResponse | ErrorResponse,
- TContext = unknown,
->(
- options?: {
- mutation?: UseMutationOptions<
- Awaited>,
- TError,
- { params?: ComfyNodesBackfillParams },
- TContext
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseMutationResult<
- Awaited>,
- TError,
- { params?: ComfyNodesBackfillParams },
- TContext
-> => {
- const mutationOptions = getComfyNodesBackfillMutationOptions(options);
-
- return useMutation(mutationOptions, queryClient);
-};
+export const useComfyNodesBackfill = (options?: { mutation?:UseMutationOptions>, TError,{params?: ComfyNodesBackfillParams}, TContext>, request?: SecondParameter}
+ , queryClient?: QueryClient): UseMutationResult<
+ Awaited>,
+ TError,
+ {params?: ComfyNodesBackfillParams},
+ TContext
+ > => {
+ const mutationOptions = getComfyNodesBackfillMutationOptions(options);
+
+ return useMutation(mutationOptions, queryClient);
+ }
+
/**
* Returns the node that contains a ComfyUI node with the specified name
* @summary Retrieve a node by ComfyUI node name
*/
export const getNodeByComfyNodeName = (
comfyNodeName: string,
- options?: SecondParameter,
- signal?: AbortSignal,
+ options?: SecondParameter,signal?: AbortSignal
) => {
- return customInstance(
- { url: `/comfy-nodes/${comfyNodeName}/node`, method: "GET", signal },
- options,
- );
-};
+
+
+ return customInstance(
+ {url: `/comfy-nodes/${comfyNodeName}/node`, method: 'GET', signal
+ },
+ options);
+ }
+
-export const getGetNodeByComfyNodeNameQueryKey = (comfyNodeName?: string) => {
- return [`/comfy-nodes/${comfyNodeName}/node`] as const;
-};
-export const getGetNodeByComfyNodeNameQueryOptions = <
- TData = Awaited>,
- TError = ErrorResponse | ErrorResponse,
->(
- comfyNodeName: string,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- >;
- request?: SecondParameter;
- },
+
+export const getGetNodeByComfyNodeNameQueryKey = (comfyNodeName?: string,) => {
+ return [
+ `/comfy-nodes/${comfyNodeName}/node`
+ ] as const;
+ }
+
+
+export const getGetNodeByComfyNodeNameQueryOptions = >, TError = ErrorResponse | ErrorResponse>(comfyNodeName: string, options?: { query?:Partial>, TError, TData>>, request?: SecondParameter}
) => {
- const { query: queryOptions, request: requestOptions } = options ?? {};
-
- const queryKey =
- queryOptions?.queryKey ??
- getGetNodeByComfyNodeNameQueryKey(comfyNodeName);
-
- const queryFn: QueryFunction<
- Awaited>
- > = ({ signal }) =>
- getNodeByComfyNodeName(comfyNodeName, requestOptions, signal);
-
- return {
- queryKey,
- queryFn,
- enabled: !!comfyNodeName,
- ...queryOptions,
- } as UseQueryOptions<
- Awaited>,
- TError,
- TData
- > & { queryKey: DataTag };
-};
-export type GetNodeByComfyNodeNameQueryResult = NonNullable<
- Awaited>
->;
-export type GetNodeByComfyNodeNameQueryError = ErrorResponse | ErrorResponse;
+const {query: queryOptions, request: requestOptions} = options ?? {};
-export function useGetNodeByComfyNodeName<
- TData = Awaited>,
- TError = ErrorResponse | ErrorResponse,
->(
- comfyNodeName: string,
- options: {
- query: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- > &
- Pick<
- DefinedInitialDataOptions<
- Awaited>,
- TError,
- Awaited>
- >,
- "initialData"
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): DefinedUseQueryResult & {
- queryKey: DataTag;
-};
-export function useGetNodeByComfyNodeName<
- TData = Awaited>,
- TError = ErrorResponse | ErrorResponse,
->(
- comfyNodeName: string,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- > &
- Pick<
- UndefinedInitialDataOptions<
- Awaited>,
- TError,
- Awaited>
- >,
- "initialData"
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseQueryResult & {
- queryKey: DataTag;
-};
-export function useGetNodeByComfyNodeName<
- TData = Awaited>,
- TError = ErrorResponse | ErrorResponse,
->(
- comfyNodeName: string,
- options?: {
- query?: Partial<
- UseQueryOptions<
- Awaited>,
- TError,
- TData
- >
- >;
- request?: SecondParameter;
- },
- queryClient?: QueryClient,
-): UseQueryResult & {
- queryKey: DataTag