変更を準備

{input: {…}} で変更を準備します。この段階では投稿を承認も公開もしません。準備が成功すると confirmationCapability と expiresAt を返します。ツールエラーでも HTTP 200 を返す場合があります。JSON リクエストの上限は 65536 バイトです。

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

認可

AuthorizationBearer トークン · header必須

権限範囲を指定した Influence API キー、または対応する OAuth アクセストークンを使用します。認証情報を URL やツールの入力に含めないでください。

パスパラメーター

toolstring必須

GET /api/v1/tools が返すツール名です。一覧は認証情報の権限で絞り込まれます。スキーマの存在は利用可能であることを保証しません。

リクエスト本文

必須application/json

inputobject必須

レスポンス

200

準備結果またはツールエラー。

次のうち1つ以上:

PreparedTool

confirmationCapabilitystring必須

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必須

summary__schema0

プロパティを表示

__schema0

toolNamestring必須

指定できる値:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobject必須

プロパティを表示

codestring必須

指定できる値:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestring必須

最小長: 1 · 最大長: 2048

retryableboolean必須

okboolean必須

toolNamestring必須

400

リクエストが無効です。クエリパラメーターは受け付けません。入力検証の失敗はツールエラー形式で返される場合があります。

次のうち1つ以上:

TransportError

errorobject必須

プロパティを表示

codestring必須

messagestring必須

retryableboolean必須

ToolError

errorobject必須

プロパティを表示

codestring必須

指定できる値:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

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必須

指定できる値:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

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": "INVALID_INPUT",
    "message": "string",
    "retryable": true
  },
  "ok": false,
  "toolName": "adAuditQuote"
}

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

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