準備變更操作

以 {input: {…}} 準備變更操作。準備不會核准或執行發布。準備成功時，會傳回 confirmationCapability 與 expiresAt；工具失敗仍可能使用 HTTP 200。JSON 請求上限為 65,536 位元組。

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

授權

AuthorizationBearer 權杖 · header必要

使用 Influence 限定權限的 API 金鑰，或受支援的 OAuth 存取權杖。不要將憑證放在網址或工具輸入中。

路徑參數

toolstring必要

由 GET /api/v1/tools 傳回的工具名稱。探索結果依此憑證權限篩選；結構存在，不代表工具可用。

請求主體

必要application/json

inputobject必要

回應

200

準備結果或工具失敗。

符合下列任一或多項:

PreparedTool

confirmationCapabilityConfirmationCapability必要

在 expiresAt 之前，透過 X-Publish-Confirmation 標頭傳回此值。

長度下限：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
  }
}