Připravit změnu

Připravte změnu pomocí {input: {…}}. Příprava neschvaluje ani neprovádí publikování. Úspěšná příprava vrátí confirmationCapability a expiresAt; chyba nástroje může stále použít HTTP 200. Požadavky JSON mají limit 65 536 bajtů.

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

Autorizace

AuthorizationToken Bearer · headerpovinné

Klíč API Influence s omezenými oprávněními nebo podporovaný přístupový token OAuth. Přístupové údaje nevkládejte do URL ani do vstupu nástroje.

Parametry cesty

toolstringpovinné

Název nástroje vrácený GET /api/v1/tools. Zjišťování je filtrované podle oprávnění tohoto přístupového údaje; přítomnost schématu nedokládá dostupnost.

Tělo požadavku

povinnéapplication/json

inputobjectpovinné

Odpovědi

200

Příprava nebo selhání nástroje.

Alespoň jedna z možností:

PreparedTool

confirmationCapabilityConfirmationCapabilitypovinné

Vraťte tuto hodnotu v hlavičce X-Publish-Confirmation před expiresAt.

min. délka: 32 · max. délka: 4096 · odpovídá vzoru ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>povinné

odpovídá vzoru ^(?:(?:\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)))$

inputDigeststringpovinné

odpovídá vzoru ^[0-9a-f]{64}$

statusstringpovinné

summaryJsonValue | null

Zobrazit vlastnosti

Alespoň jedna z možností:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Pole prvků typu JsonValue

Cyklický odkaz na JsonValue.

object

object

toolNamestringpovinné

Povolené hodnoty:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

Povolené hodnoty:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringpovinné

min. délka: 1 · max. délka: 2048

retryablebooleanpovinné

okbooleanpovinné

toolNamestringpovinné

400

Neplatný požadavek. Parametry dotazu nejsou přijímány. Chyby validace nástroje mohou používat chybovou obálku nástroje.

Alespoň jedna z možností:

TransportError

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

ToolError

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

min. délka: 1 · max. délka: 2048

retryablebooleanpovinné

okbooleanpovinné

toolNamestringpovinné

401

Přístupový údaj bearer chybí, je neplatný nebo mu vypršela platnost.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

403

Přístupový údaj nemá požadovaná oprávnění.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

404

Strojové API nebo požadovaný nástroj není dostupný.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

413

Požadavek překračuje limit v bajtech.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

min. délka: 1 · max. délka: 2048

retryablebooleanpovinné

okbooleanpovinné

toolNamestringpovinné

429

Byl překročen limit četnosti požadavků. Požadavek lze opakovat.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

503

API nebo navazující provedení požadavku není dostupné.

errorobjectpovinné

Zobrazit vlastnosti

codestringpovinné

messagestringpovinné

retryablebooleanpovinné

Požadavek

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

Odpověď

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