Przygotuj zmianę

Przygotuj zmianę z {input: {…}}. Przygotowanie nie zatwierdza ani nie wykonuje publikacji. Pomyślne przygotowanie zwraca confirmationCapability i expiresAt; odpowiedź z informacją o niepowodzeniu narzędzia może mieć status HTTP 200. Limit żądań JSON wynosi 65 536 bajtów.

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

Autoryzacja

AuthorizationToken Bearer · headerwymagane

Klucz API Influence o ograniczonym zakresie uprawnień lub obsługiwany token dostępu OAuth. Nie umieszczaj danych uwierzytelniających w adresach URL ani danych wejściowych narzędzi.

Parametry ścieżki

toolstringwymagane

Nazwa narzędzia zwrócona przez GET /api/v1/tools. Wykrywanie jest filtrowane według uprawnień tych danych uwierzytelniających; obecność schematu nie oznacza dostępności.

Treść żądania

wymaganeapplication/json

inputobjectwymagane

Odpowiedzi

200

Przygotowanie lub niepowodzenie narzędzia.

Co najmniej jeden z:

PreparedTool

confirmationCapabilityConfirmationCapabilitywymagane

Przekaż tę wartość w nagłówku X-Publish-Confirmation przed expiresAt.

min. długość: 32 · maks. długość: 4096 · pasuje do wzorca ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>wymagane

pasuje do wzorca ^(?:(?:\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)))$

inputDigeststringwymagane

pasuje do wzorca ^[0-9a-f]{64}$

statusstringwymagane

summaryJsonValue | null

Pokaż właściwości

Co najmniej jeden z:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Tablica elementów typu JsonValue

Odwołanie cykliczne do JsonValue.

object

object

toolNamestringwymagane

Dozwolone wartości:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectwymagane

Pokaż właściwości

codestringwymagane

Dozwolone wartości:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwymagane

min. długość: 1 · maks. długość: 2048

retryablebooleanwymagane

okbooleanwymagane

toolNamestringwymagane

400

Nieprawidłowe żądanie. Parametry zapytania nie są przyjmowane. Błędy walidacji narzędzia mogą mieć strukturę odpowiedzi błędu narzędzia.

Co najmniej jeden z:

TransportError

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

ToolError

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

min. długość: 1 · maks. długość: 2048

retryablebooleanwymagane

okbooleanwymagane

toolNamestringwymagane

401

Nie podano danych uwierzytelniających Bearer albo są one nieprawidłowe lub wygasły.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

403

Dane uwierzytelniające nie obejmują wymaganych uprawnień.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

404

API dla klientów maszynowych lub żądane narzędzie jest niedostępne.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

413

Żądanie przekracza limit bajtów.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

min. długość: 1 · maks. długość: 2048

retryablebooleanwymagane

okbooleanwymagane

toolNamestringwymagane

429

Przekroczono limit częstotliwości żądań. Ten błąd pozwala na ponowienie próby.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

503

API lub jego zaplecze wykonawcze jest niedostępne.

errorobjectwymagane

Pokaż właściwości

codestringwymagane

messagestringwymagane

retryablebooleanwymagane

Żądanie

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

Odpowiedź

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