הכנת פעולה שמשנה מצב

הכינו פעולה שמשנה מצב עם {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
  }
}