Préparer une modification

Préparez une modification avec {input: {…}}. Cette étape n’approuve ni n’effectue la publication. En cas de réussite, elle renvoie confirmationCapability et expiresAt ; une erreur d’outil peut aussi renvoyer HTTP 200. Les requêtes JSON sont limitées à 65536 octets.

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

Autorisation

AuthorizationJeton Bearer · headerobligatoire

Clé API Influence avec des autorisations limitées ou jeton d’accès OAuth pris en charge. Ne placez jamais les identifiants dans les URL ni dans les données des outils.

Paramètres de chemin

toolstringobligatoire

Nom d’outil renvoyé par GET /api/v1/tools. La liste dépend des autorisations des identifiants ; la présence d’un schéma ne garantit pas la disponibilité.

Corps de la requête

obligatoireapplication/json

inputobjectobligatoire

Réponses

200

Préparation ou erreur d’outil.

Une ou plusieurs de:

PreparedTool

confirmationCapabilitystringobligatoire

Renvoyez cette valeur dans l’en-tête X-Publish-Confirmation avant expiresAt.

longueur min. : 32 · longueur max. : 4096 · correspond à ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>obligatoire

correspond à ^(?:(?:\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)))$

inputDigeststringobligatoire

correspond à ^[0-9a-f]{64}$

statusstringobligatoire

summary__schema0

Afficher les propriétés

__schema0

toolNamestringobligatoire

Valeurs autorisées :adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

Valeurs autorisées :INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatoire

longueur min. : 1 · longueur max. : 2048

retryablebooleanobligatoire

okbooleanobligatoire

toolNamestringobligatoire

400

Requête non valide. Les paramètres de requête sont refusés. Les erreurs de validation peuvent utiliser l’enveloppe d’erreur d’un outil.

Une ou plusieurs de:

TransportError

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

ToolError

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

Valeurs autorisées :INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatoire

longueur min. : 1 · longueur max. : 2048

retryablebooleanobligatoire

okbooleanobligatoire

toolNamestringobligatoire

401

Identifiant bearer absent, non valide ou expiré.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

403

Les identifiants ne disposent pas des autorisations requises.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

404

L’API ou l’outil demandé est indisponible.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

413

La requête dépasse la limite en octets.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

Valeurs autorisées :INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatoire

longueur min. : 1 · longueur max. : 2048

retryablebooleanobligatoire

okbooleanobligatoire

toolNamestringobligatoire

429

Limite de requêtes dépassée. Une nouvelle tentative est possible.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

503

L’API ou le service chargé de l’exécution est indisponible.

errorobjectobligatoire

Afficher les propriétés

codestringobligatoire

messagestringobligatoire

retryablebooleanobligatoire

Requête

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

Réponse

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