Förbered en ändring

Förbered en ändring med {input: {…}}. Förberedelsen varken godkänner eller utför publicering. En lyckad förberedelse returnerar confirmationCapability och expiresAt; ett verktygsfel kan ändå returneras med HTTP 200. JSON-begäranden är begränsade till 65 536 byte.

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

Auktorisering

AuthorizationBearer-token · headerobligatorisk

Influence-API-nyckel med avgränsade behörigheter eller en OAuth-åtkomsttoken som stöds. Håll autentiseringsuppgifter borta från URL:er och verktygsindata.

Sökvägsparametrar

toolstringobligatorisk

Verktygsnamn som returneras av GET /api/v1/tools. Upptäckten filtreras efter autentiseringsuppgifternas behörigheter; att ett schema finns visar inte att verktyget är tillgängligt.

Anropskropp

obligatoriskapplication/json

inputobjectobligatorisk

Svar

200

Förberedelse eller verktygsfel.

Minst ett av:

PreparedTool

confirmationCapabilityConfirmationCapabilityobligatorisk

Skicka tillbaka det här värdet i huvudet X-Publish-Confirmation innan expiresAt.

minst 32 tecken · högst 4096 tecken · matchar ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>obligatorisk

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

inputDigeststringobligatorisk

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

statusstringobligatorisk

summaryJsonValue | null

Visa egenskaper

Minst ett av:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Array med element av typen JsonValue

Cirkulär referens till JsonValue.

object

object

toolNamestringobligatorisk

Tillåtna värden:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

Tillåtna värden:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorisk

minst 1 tecken · högst 2048 tecken

retryablebooleanobligatorisk

okbooleanobligatorisk

toolNamestringobligatorisk

400

Ogiltig begäran. Frågeparametrar accepteras inte. Verktygets valideringsfel kan returneras i en struktur för verktygsfel.

Minst ett av:

TransportError

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

ToolError

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

minst 1 tecken · högst 2048 tecken

retryablebooleanobligatorisk

okbooleanobligatorisk

toolNamestringobligatorisk

401

Bearer-autentiseringsuppgifter saknas, är ogiltiga eller har löpt ut.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

403

Autentiseringsuppgifterna saknar nödvändiga behörigheter.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

404

Maskin-API:et eller det begärda verktyget är inte tillgängligt.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

413

Begäran överskrider bytegränsen.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

minst 1 tecken · högst 2048 tecken

retryablebooleanobligatorisk

okbooleanobligatorisk

toolNamestringobligatorisk

429

Anropsgränsen har överskridits. Ett nytt försök kan göras för det här felet.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

503

API:et är inte tillgängligt, eller så är den bakomliggande körningen inte tillgänglig.

errorobjectobligatorisk

Visa egenskaper

codestringobligatorisk

messagestringobligatorisk

retryablebooleanobligatorisk

Anrop

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