Maghanda ng pagbabago

Maghanda ng pagbabago gamit ang {input: {…}}. Hindi inaaprubahan o isinasagawa ng paghahanda ang pag-publish. Kapag matagumpay, ibinabalik ang confirmationCapability at expiresAt; maaari ring gumamit ng HTTP 200 ang tool error. Hanggang 65536 bytes lang ang JSON request.

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

Awtorisasyon

AuthorizationBearer token · headerkailangan

Influence API key na may takdang permissions o suportadong OAuth access token. Huwag ilagay ang credentials sa mga URL o tool input.

Mga parameter ng path

toolstringkailangan

Pangalan ng tool mula sa GET /api/v1/tools. Nakadepende ang listahan sa permissions ng credentials; hindi garantiya ng availability ang pagkakaroon ng schema.

Nilalaman ng request

kailanganapplication/json

inputobjectkailangan

Mga tugon

200

Paghahanda o tool error.

Isa o higit pa sa:

PreparedTool

confirmationCapabilitystringkailangan

Ibalik ang value na ito sa X-Publish-Confirmation header bago ang expiresAt.

minimum na haba: 32 · maximum na haba: 4096 · tumutugma sa ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>kailangan

tumutugma sa ^(?:(?:\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)))$

inputDigeststringkailangan

tumutugma sa ^[0-9a-f]{64}$

statusstringkailangan

summary__schema0

Ipakita ang mga property

__schema0

toolNamestringkailangan

Mga pinapayagang halaga:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

400

Hindi valid ang request. Hindi tinatanggap ang query parameters. Maaaring gumamit ng tool error format ang mga validation failure.

Isa o higit pa sa:

TransportError

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

ToolError

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

401

Wala, hindi valid, o expired ang bearer credentials.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

403

Kulang ang kinakailangang permissions ng credentials.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

404

Hindi available ang API o ang hiniling na tool.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

413

Lumampas sa byte limit ang request.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

429

Lumampas sa request limit. Maaaring subukan ulit.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

503

Hindi available ang API o ang serbisyong nagpapatakbo ng operasyon.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

Request

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}",
)

Tugon

{
  "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
  }
}