Prepara una modifica

Prepara una modifica con {input: {…}}. La preparazione non approva né esegue la pubblicazione. Una preparazione riuscita restituisce confirmationCapability ed expiresAt; un errore dello strumento può comunque usare HTTP 200. Le richieste JSON hanno un limite di 65.536 byte.

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

Autorizzazione

AuthorizationToken Bearer · headerobbligatorio

Chiave API Influence con ambiti di autorizzazione limitati o token di accesso OAuth supportato. Tieni le credenziali fuori dagli URL e dall’input degli strumenti.

Parametri del percorso

toolstringobbligatorio

Nome dello strumento restituito da GET /api/v1/tools. Il rilevamento è filtrato dalle autorizzazioni di questa credenziale; la presenza dello schema non dimostra la disponibilità.

Corpo della richiesta

obbligatorioapplication/json

inputobjectobbligatorio

Risposte

200

Preparazione o errore dello strumento.

Almeno una delle seguenti opzioni:

PreparedTool

confirmationCapabilityConfirmationCapabilityobbligatorio

Restituisci questo valore nell’header X-Publish-Confirmation prima di expiresAt.

lunghezza minima 32 · lunghezza massima 4096 · corrisponde a ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>obbligatorio

corrisponde a ^(?:(?:\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)))$

inputDigeststringobbligatorio

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

statusstringobbligatorio

summaryJsonValue | null

Mostra le proprietà

Almeno una delle seguenti opzioni:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Array di JsonValue

Riferimento circolare a JsonValue.

object

object

toolNamestringobbligatorio

Valori consentiti:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

Valori consentiti:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobbligatorio

lunghezza minima 1 · lunghezza massima 2048

retryablebooleanobbligatorio

okbooleanobbligatorio

toolNamestringobbligatorio

400

Richiesta non valida. I parametri di query non sono accettati. Gli errori di convalida degli strumenti possono usare una struttura di risposta di errore dello strumento.

Almeno una delle seguenti opzioni:

TransportError

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

ToolError

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

lunghezza minima 1 · lunghezza massima 2048

retryablebooleanobbligatorio

okbooleanobbligatorio

toolNamestringobbligatorio

401

Credenziale Bearer mancante, non valida o scaduta.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

403

La credenziale non dispone delle autorizzazioni richieste.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

404

L’API per l’accesso programmatico o lo strumento richiesto non è disponibile.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

413

La richiesta supera il limite in byte.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

lunghezza minima 1 · lunghezza massima 2048

retryablebooleanobbligatorio

okbooleanobbligatorio

toolNamestringobbligatorio

429

Limite di frequenza superato. È possibile riprovare.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

503

L’API o il servizio di esecuzione a monte non è disponibile.

errorobjectobbligatorio

Mostra le proprietà

codestringobbligatorio

messagestringobbligatorio

retryablebooleanobbligatorio

Richiesta

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

Risposta

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