Siapkan perubahan

Siapkan perubahan dengan {input: {…}}. Persiapan tidak menyetujui atau menjalankan publikasi. Jika berhasil, respons berisi confirmationCapability dan expiresAt; error tool juga dapat memakai HTTP 200. Permintaan JSON dibatasi hingga 65536 byte.

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

Otorisasi

AuthorizationToken Bearer · headerwajib

Kunci API Influence dengan izin terbatas atau token akses OAuth yang didukung. Jangan sertakan kredensial dalam URL atau input tool.

Parameter path

toolstringwajib

Nama tool yang dikembalikan oleh GET /api/v1/tools. Daftar difilter berdasarkan izin kredensial; adanya skema tidak menjamin ketersediaan.

Isi permintaan

wajibapplication/json

inputobjectwajib

Respons

200

Persiapan atau error tool.

Satu atau lebih dari:

PreparedTool

confirmationCapabilitystringwajib

Kirim kembali nilai ini melalui header X-Publish-Confirmation sebelum expiresAt.

panjang min.: 32 · panjang maks.: 4096 · sesuai dengan ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>wajib

sesuai 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

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

statusstringwajib

summary__schema0

Tampilkan properti

__schema0

toolNamestringwajib

Nilai yang diizinkan:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectwajib

Tampilkan properti

codestringwajib

Nilai yang diizinkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang min.: 1 · panjang maks.: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

400

Permintaan tidak valid. Parameter kueri tidak diterima. Kegagalan validasi dapat menggunakan format error tool.

Satu atau lebih dari:

TransportError

errorobjectwajib

Tampilkan properti

codestringwajib

messagestringwajib

retryablebooleanwajib

ToolError

errorobjectwajib

Tampilkan properti

codestringwajib

Nilai yang diizinkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang min.: 1 · panjang maks.: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

401

Kredensial bearer tidak ada, tidak valid, atau kedaluwarsa.

errorobjectwajib

Tampilkan properti

codestringwajib

messagestringwajib

retryablebooleanwajib

403

Kredensial tidak memiliki izin yang diperlukan.

errorobjectwajib

Tampilkan properti

codestringwajib

messagestringwajib

retryablebooleanwajib

404

API atau tool yang diminta tidak tersedia.

errorobjectwajib

Tampilkan properti

codestringwajib

messagestringwajib

retryablebooleanwajib

413

Permintaan melebihi batas byte.

errorobjectwajib

Tampilkan properti

codestringwajib

Nilai yang diizinkan:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringwajib

panjang min.: 1 · panjang maks.: 2048

retryablebooleanwajib

okbooleanwajib

toolNamestringwajib

429

Batas permintaan terlampaui. Permintaan dapat dicoba lagi.

errorobjectwajib

Tampilkan properti

codestringwajib

messagestringwajib

retryablebooleanwajib

503

API atau layanan yang menjalankan operasi tidak tersedia.

errorobjectwajib

Tampilkan properti

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