Sediakan perubahan

Sediakan perubahan dengan {input: {…}}. Penyediaan tidak meluluskan atau menjalankan penerbitan. Jika berjaya, respons mengandungi confirmationCapability dan expiresAt; ralat alat juga boleh menggunakan HTTP 200. Permintaan JSON dihadkan kepada 65536 bait.

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

Kebenaran akses

AuthorizationToken Bearer · headerwajib

Kunci API Influence dengan kebenaran terhad atau token akses OAuth yang disokong. Jangan letakkan kelayakan akses dalam URL atau input alat.

Parameter laluan

toolstringwajib

Nama alat yang dikembalikan oleh GET /api/v1/tools. Senarai ditapis mengikut kebenaran kelayakan akses; kewujudan skema tidak menjamin ketersediaan.

Badan permintaan

wajibapplication/json

inputobjectwajib

Respons

200

Penyediaan atau ralat alat.

Satu atau lebih daripada:

PreparedTool

confirmationCapabilitystringwajib

Hantar semula nilai ini melalui pengepala X-Publish-Confirmation sebelum expiresAt.

panjang minimum: 32 · panjang maksimum: 4096 · sepadan dengan ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>wajib

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

inputDigeststringwajib

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

statusstringwajib

summary__schema0

Paparkan sifat

__schema0

toolNamestringwajib

Nilai yang dibenarkan:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectwajib

Paparkan sifat

codestringwajib

Nilai yang dibenarkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang minimum: 1 · panjang maksimum: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

400

Permintaan tidak sah. Parameter pertanyaan tidak diterima. Kegagalan pengesahan input boleh menggunakan format ralat alat.

Satu atau lebih daripada:

TransportError

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

ToolError

errorobjectwajib

Paparkan sifat

codestringwajib

Nilai yang dibenarkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang minimum: 1 · panjang maksimum: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

401

Kelayakan bearer tiada, tidak sah atau telah tamat tempoh.

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

403

Kelayakan akses tidak mempunyai kebenaran yang diperlukan.

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

404

API atau alat yang diminta tidak tersedia.

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

413

Permintaan melebihi had bait.

errorobjectwajib

Paparkan sifat

codestringwajib

Nilai yang dibenarkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang minimum: 1 · panjang maksimum: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

429

Had permintaan telah dilampaui. Permintaan boleh dicuba semula.

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

503

API atau perkhidmatan yang menjalankan operasi tidak tersedia.

errorobjectwajib

Paparkan sifat

codestringwajib

messagestringwajib

retryablebooleanwajib

Permintaan

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

Respons

{
  "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": "INVALID_INPUT",
    "message": "string",
    "retryable": true
  },
  "ok": false,
  "toolName": "adAuditQuote"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}