Klargjør en endring

Klargjør en endring med {input: {…}}. Klargjøring godkjenner eller utfører ikke publisering. Vellykket klargjøring returnerer confirmationCapability og expiresAt. En verktøyfeil kan fortsatt bruke HTTP 200. JSON-forespørsler er begrenset til 65 536 byte.

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

Autorisasjon

AuthorizationBearer-token · headerpåkrevd

Influence-API-nøkkel med avgrenset tilgang eller et støttet OAuth-tilgangstoken. Hold tilgangsopplysninger utenfor URL-er og inndata til verktøy.

Stiparametere

toolstringpåkrevd

Verktøynavn som returneres av GET /api/v1/tools. Oppslaget filtreres etter tillatelsene som tilgangsopplysningene gir. At et skjema finnes, bekrefter ikke at verktøyet er tilgjengelig.

Forespørselskropp

påkrevdapplication/json

inputobjectpåkrevd

Svar

200

Klargjøring eller verktøyfeil.

Minst ett av:

PreparedTool

confirmationCapabilityConfirmationCapabilitypåkrevd

Send denne verdien tilbake i X-Publish-Confirmation-hodet før expiresAt.

minste lengde: 32 · maksimal lengde: 4096 · samsvarer med ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>påkrevd

samsvarer med ^(?:(?:\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åkrevd

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

statusstringpåkrevd

summaryJsonValue | null

Vis egenskaper

Minst ett av:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Liste med JsonValue

Sirkulær referanse til JsonValue.

object

object

toolNamestringpåkrevd

Tillatt:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

Tillatt:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringpåkrevd

minste lengde: 1 · maksimal lengde: 2048

retryablebooleanpåkrevd

okbooleanpåkrevd

toolNamestringpåkrevd

400

Ugyldig forespørsel. Spørringsparametere godtas ikke. Feil ved verktøyvalidering kan returneres i et omsluttende feilobjekt for verktøy.

Minst ett av:

TransportError

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

ToolError

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

Tillatt:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringpåkrevd

minste lengde: 1 · maksimal lengde: 2048

retryablebooleanpåkrevd

okbooleanpåkrevd

toolNamestringpåkrevd

401

Tilgangsopplysningene for Bearer-autentisering mangler, er ugyldige eller har utløpt.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

403

Tilgangsopplysningene mangler nødvendige tillatelser.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

404

Maskin-API-et eller det forespurte verktøyet er utilgjengelig.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

413

Forespørselen overskrider bytegrensen.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

Tillatt:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringpåkrevd

minste lengde: 1 · maksimal lengde: 2048

retryablebooleanpåkrevd

okbooleanpåkrevd

toolNamestringpåkrevd

429

Grensen for forespørsler per tidsrom er overskredet. Du kan prøve på nytt ved denne feilen.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

503

API-et eller kjøringen det avhenger av, er utilgjengelig.

errorobjectpåkrevd

Vis egenskaper

codestringpåkrevd

messagestringpåkrevd

retryablebooleanpåkrevd

Forespørsel

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