تحضير عملية تعديل

حضر عملية تعديل باستخدام {input: {…}}. لا يمنح التحضير موافقة على النشر ولا ينفذه. عند نجاح التحضير، تعاد confirmationCapability وexpiresAt؛ وقد تعاد استجابة إخفاق للأداة برمز HTTP 200 أيضا. يقتصر حجم طلبات JSON على 65,536 بايت.

POST/api/v1/tools/{tool}/prepare

التفويض

Authorizationرمز Bearer · headerمطلوب

مفتاح API من Influence بصلاحيات محددة، أو رمز وصول OAuth مدعوم. لا تدرج بيانات الاعتماد في عناوين URL أو مدخلات الأدوات.

معاملات المسار

toolstringمطلوب

اسم الأداة الذي تعيده GET /api/v1/tools. تقتصر نتائج الاستكشاف على صلاحيات بيانات الاعتماد هذه؛ وجود المخطط لا يثبت إتاحة الأداة.

محتوى الطلب

مطلوبapplication/json

inputobjectمطلوب

الاستجابات

200

نتيجة التحضير أو إخفاق الأداة.

واحد أو أكثر مما يلي:

PreparedTool

confirmationCapabilityConfirmationCapabilityمطلوب

أعد هذه القيمة في الترويسة X-Publish-Confirmation قبل expiresAt.

الطول الأدنى: 32 · الطول الأقصى: 4096 · يطابق ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>مطلوب

يطابق ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

inputDigeststringمطلوب

يطابق ^[0-9a-f]{64}$

statusstringمطلوب

summaryJsonValue | null

عرض الخصائص

واحد أو أكثر مما يلي:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

مصفوفة من JsonValue

مرجع دائري إلى JsonValue.

object

object

toolNamestringمطلوب

القيم المسموح بها:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

القيم المسموح بها:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringمطلوب

الطول الأدنى: 1 · الطول الأقصى: 2048

retryablebooleanمطلوب

okbooleanمطلوب

toolNamestringمطلوب

400

الطلب غير صالح. معاملات الاستعلام غير مقبولة. قد ترد أخطاء التحقق الخاصة بالأداة ضمن استجابة خطأ للأداة.

واحد أو أكثر مما يلي:

TransportError

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

ToolError

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

الطول الأدنى: 1 · الطول الأقصى: 2048

retryablebooleanمطلوب

okbooleanمطلوب

toolNamestringمطلوب

401

بيانات اعتماد Bearer غير موجودة أو غير صالحة أو منتهية الصلاحية.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

403

بيانات الاعتماد لا تتضمن الصلاحيات المطلوبة.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

404

واجهة API المخصصة للبرامج أو الأداة المطلوبة غير متاحة.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

413

يتجاوز الطلب الحد الأقصى للبايتات.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

الطول الأدنى: 1 · الطول الأقصى: 2048

retryablebooleanمطلوب

okbooleanمطلوب

toolNamestringمطلوب

429

جرى تجاوز حد معدل الطلبات. يمكن إعادة المحاولة بعد هذا الخطأ.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

503

واجهة API أو خدمة التنفيذ التي تعتمد عليها غير متاحة.

errorobjectمطلوب

عرض الخصائص

codestringمطلوب

messagestringمطلوب

retryablebooleanمطلوب

الطلب

curl -X POST 'https://influence.so/api/v1/tools/string/prepare' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "property1": "string",
    "property2": "string"
  }
}'

const response = await fetch("https://influence.so/api/v1/tools/string/prepare", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}"
});

import requests

response = requests.post(
    "https://influence.so/api/v1/tools/string/prepare",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}",
)

الاستجابة

{
  "confirmationCapability": "stringstringstringstringstringst",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inputDigest": "string",
  "status": "confirmation_required",
  "summary": "string",
  "toolName": "adAuditQuote"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "AI_SCHEDULING_LIMIT_REACHED",
    "message": "string",
    "retryable": true
  },
  "ok": false,
  "toolName": "adAuditQuote"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}