Sari la conținut
Influence
Esc
↑↓navighează↵deschide⌘Jprevizualizează

Pregătește o modificare

Pregătește o modificare cu {input: {…}}. Pregătirea nu aprobă și nu execută publicarea. O pregătire reușită returnează confirmationCapability și expiresAt; un eșec al instrumentului poate folosi tot HTTP 200. Cererile JSON sunt limitate la 65.536 de octeți.

POST/api/v1/tools/{tool}/prepare
Autorizare
AuthorizationToken Bearer · headerobligatoriu

Cheie API Influence cu permisiuni limitate sau token de acces OAuth acceptat. Nu include datele de acces în URL-uri sau în datele de intrare ale instrumentelor.

Parametri de cale
toolstringobligatoriu

Numele instrumentului returnat de GET /api/v1/tools. Descoperirea este filtrată după permisiunile acestor date de acces; prezența schemei nu confirmă disponibilitatea.

Corpul cererii
obligatoriuapplication/json
inputobjectobligatoriu
Răspunsuri
200

Pregătire sau eșec al instrumentului.

Una sau mai multe variante:
PreparedTool
confirmationCapabilityConfirmationCapabilityobligatoriu

Returnează această valoare în antetul X-Publish-Confirmation înainte de expiresAt.

lungime minimă: 32 · lungime maximă: 4096 · corespunde modelului ^[A-Za-z0-9._~-]+$
expiresAtstring<date-time>obligatoriu
corespunde modelului ^(?:(?:\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)))$
inputDigeststringobligatoriu
corespunde modelului ^[0-9a-f]{64}$
statusstringobligatoriu
summaryJsonValue | null
Afișează proprietățile
Una sau mai multe variante:
string
string
number
number
boolean
boolean
null
null
JsonValue[]
Tablou cu elemente de tip JsonValue
Referință circulară la JsonValue.
object
object
toolNamestringobligatoriu
Valori permise:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
ToolError
errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
Valori permise:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringobligatoriu
lungime minimă: 1 · lungime maximă: 2048
retryablebooleanobligatoriu
okbooleanobligatoriu
toolNamestringobligatoriu
Valori permise:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
400

Cerere nevalidă. Parametrii de interogare nu sunt acceptați. Erorile de validare ale instrumentelor pot folosi structura unui răspuns de eroare al instrumentului.

Una sau mai multe variante:
TransportError
errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
ToolError
errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
Valori permise:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringobligatoriu
lungime minimă: 1 · lungime maximă: 2048
retryablebooleanobligatoriu
okbooleanobligatoriu
toolNamestringobligatoriu
Valori permise:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
401

Datele de acces bearer lipsesc, sunt nevalide sau au expirat.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
403

Datele de acces nu au permisiunile necesare.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
404

API-ul pentru acces programatic sau instrumentul solicitat nu este disponibil.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
413

Cererea depășește limita de octeți.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
Valori permise:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringobligatoriu
lungime minimă: 1 · lungime maximă: 2048
retryablebooleanobligatoriu
okbooleanobligatoriu
toolNamestringobligatoriu
Valori permise:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
429

Limita de frecvență a cererilor a fost depășită. Eroarea permite reîncercarea.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
503

API-ul sau serviciul din amonte care îl execută nu este disponibil.

errorobjectobligatoriu
Afișează proprietățile
codestringobligatoriu
messagestringobligatoriu
retryablebooleanobligatoriu
Cerere
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"
  }
}'
Răspuns
{
  "confirmationCapability": "stringstringstringstringstringst",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inputDigest": "string",
  "status": "confirmation_required",
  "summary": "string",
  "toolName": "adAuditQuote"
}