Forbered en ændring

Forbered en ændring med {input: {…}}. Forberedelsen godkender eller udfører ikke udgivelse. En vellykket forberedelse returnerer confirmationCapability og expiresAt; en værktøjsfejl kan stadig bruge HTTP 200. JSON-anmodninger er begrænset til 65.536 bytes.

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

Autorisation

AuthorizationBearer-token · headerpåkrævet

Influence-API-nøgle med afgrænsede tilladelser eller understøttet OAuth-adgangstoken. Hold adgangsoplysninger ude af URL’er og værktøjsinput.

Stiparametre

toolstringpåkrævet

Værktøjsnavn returneret af GET /api/v1/tools. Værktøjsoversigten filtreres efter adgangsoplysningernes tilladelser; et skema betyder ikke i sig selv, at værktøjet er tilgængeligt.

Anmodningsindhold

påkrævetapplication/json

inputobjectpåkrævet

Svar

200

Forberedelse eller værktøjsfejl.

En eller flere af:

PreparedTool

confirmationCapabilityConfirmationCapabilitypåkrævet

Send denne værdi i headeren X-Publish-Confirmation før expiresAt.

min. længde: 32 · maks. længde: 4096 · matcher ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>påkrævet

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

inputDigeststringpåkrævet

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

statusstringpåkrævet

summaryJsonValue | null

Vis egenskaber

En eller flere af:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Array af JsonValue

Cirkulær reference til JsonValue.

object

object

toolNamestringpåkrævet

Tilladte værdier:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

Tilladte værdier:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringpåkrævet

min. længde: 1 · maks. længde: 2048

retryablebooleanpåkrævet

okbooleanpåkrævet

toolNamestringpåkrævet

400

Ugyldig anmodning. Forespørgselsparametre accepteres ikke. Valideringsfejl i et værktøj kan returneres i værktøjets fejlformat.

En eller flere af:

TransportError

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

ToolError

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

min. længde: 1 · maks. længde: 2048

retryablebooleanpåkrævet

okbooleanpåkrævet

toolNamestringpåkrævet

401

Manglende, ugyldige eller udløbne Bearer-adgangsoplysninger.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

403

Adgangsoplysningerne mangler de påkrævede tilladelser.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

404

Maskin-API’et eller det ønskede værktøj er ikke tilgængeligt.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

413

Anmodningen overskrider bytegrænsen.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

min. længde: 1 · maks. længde: 2048

retryablebooleanpåkrævet

okbooleanpåkrævet

toolNamestringpåkrævet

429

Kaldgrænsen er overskredet. Der kan forsøges igen.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

503

API’et eller den bagvedliggende afvikling er ikke tilgængelig.

errorobjectpåkrævet

Vis egenskaber

codestringpåkrævet

messagestringpåkrævet

retryablebooleanpåkrævet

Anmodning

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

Svar

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