HomeSupportStudio
واجهة برمجة تطبيقات الشريك

الحصول على مدخلات سير عمل

اقرأ المدخلات التي تتطلبها أداة سير العمل قبل بدء التشغيل.

تُؤلَّف مدخلات سير العمل في Studio وتتغير عندما يغيرها مؤلفوها. اقرأ العقد بدلًا من ترميزه بشكل ثابت.

GET {base_url}/workflows/{workflow_id}/inputs

يتطلب workflows:read.

الاستجابة

{
  "workflow": {
    "id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
    "name": "Story visuals",
    "version_id": "0192f3c4-1a02-7bb3-9f40-2c6e8d1a5b77",
    "schema_hash": "9fdf032d5b1c4e88",
    "credits_estimate": 1840,
    "duration_seconds_estimate": 420
  },
  "inputs": [
    {
      "key": "story_document",
      "accepts": "url",
      "type": "document",
      "required": true,
      "allow_multiple": false,
      "url_content_types": ["application/pdf", "text/plain", "text/markdown"],
      "max_bytes": 104857600,
      "title": "Story document",
      "description": "The finished story to adapt"
    },
    {
      "key": "tone",
      "accepts": "value",
      "type": "string",
      "required": true,
      "allow_multiple": false,
      "allowed_values": ["thriller", "romance", "mythology"],
      "allow_custom": false,
      "default_value": "thriller",
      "title": "Tone"
    }
  ]
}

كائن سير العمل

الحقلالمعنى
version_idالإصدار الذي سيُنفَّذ الآن. أَعِده في عملية التشغيل لتثبيت هذا العقد بالضبط
schema_hashيتغير عندما يتغير أي مدخل. الحقل الوحيد للمقارنة مع ذاكرة التخزين المؤقت لديك
credits_estimateالأرصدة التي كانت تكلفة تشغيل هذا سير العمل بها في المتوسط
duration_seconds_estimateالمدة التي كان يستغرقها في المتوسط، من البداية إلى النهاية

كل مدخل

الحقلالمعنى
keyالاسم الذي يجب استخدامه في كائن inputs الخاص بالتشغيل
acceptsvalue أرسل القيمة نفسها · url أرسل رابط HTTPS عامًّا · option أرسل أحد options[].id
typestring, number, boolean, image, video, audio أو document
requiredيجب أن يكون موجودًا، ما لم يتم تعيين default_value
allow_multipleعندما تكون true، يمكن أن تكون القيمة مصفوفة؛ وعندما تكون false، تُرفَض المصفوفة
allowed_valuesلـ accepts: value: السلاسل النصية الوحيدة المقبولة، ما لم تكن قيمة allow_custom هي true
allow_customعندما تكون false، تُرفَض القيم خارج allowed_values أو options
minimum, maximumحدود شاملة، لـ type: number
default_valueما يستخدمه التشغيل عندما يُحذف المدخل
url_content_typesلـ accepts: url: أنواع المحتوى التي قد يقدمها الرابط
max_bytesلـ accepts: url: أكبر ملف مقبول لهذا المدخل
optionsلـ accepts: option: مدخلات { "id", "label" }. أعد إرسال id كما هو تمامًا؛ فهو ليس رابطًا
title, descriptionمكتوب للبشر، وآمن لعرضه في واجهة المستخدم الخاصة بك

خزِّن العقد مؤقتًا مقابل schema_hash، وأعد قراءته عندما يُرفَض تشغيلٌ مع invalid_request. يمكن لمؤلفي سير العمل إضافة مدخل مطلوب بين تشغيلين من تشغيلاتك.

الاتفاقيات

المعرفات، والطوابع الزمنية، وبنية الخطأ، وإصدارات النسخ، ومحاولات الإعادة.

تمرير الملفات عبر عنوان URL

الشروط التي يجب أن يستوفيها رابط الملف، وأنواع المحتوى التي يقبلها كل إدخال.

في هذه الصفحة

الاستجابةكائن سير العملكل مدخل