เตรียมการเปลี่ยนแปลง

เตรียมการเปลี่ยนแปลงด้วย {input: {…}} ขั้นตอนนี้ไม่ได้อนุมัติหรือดำเนินการเผยแพร่ เมื่อเตรียมสำเร็จจะส่งคืน confirmationCapability และ expiresAt ข้อผิดพลาดของเครื่องมืออาจใช้ HTTP 200 ได้เช่นกัน คำขอ JSON มีขนาดได้ไม่เกิน 65536 ไบต์

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

การอนุญาตสิทธิ์

Authorizationโทเค็น Bearer · headerจำเป็น

ใช้คีย์ API ของ Influence ที่กำหนดขอบเขตสิทธิ์ หรือโทเค็นการเข้าถึง OAuth ที่รองรับ ห้ามใส่ข้อมูลยืนยันตัวตนใน URL หรือข้อมูลนำเข้าของเครื่องมือ

พารามิเตอร์พาธ

toolstringจำเป็น

ชื่อเครื่องมือที่ส่งคืนจาก GET /api/v1/tools รายการจะกรองตามสิทธิ์ของข้อมูลยืนยันตัวตน การมีสคีมาไม่ได้ยืนยันว่าเครื่องมือพร้อมใช้งาน

เนื้อหาคำขอ

จำเป็นapplication/json

inputobjectจำเป็น

การตอบกลับ

200

ผลการเตรียมหรือข้อผิดพลาดของเครื่องมือ

อย่างน้อยหนึ่งรายการจาก:

PreparedTool

confirmationCapabilitystringจำเป็น

ส่งค่านี้กลับในส่วนหัว X-Publish-Confirmation ก่อน expiresAt

ความยาวต่ำสุด 32 · ความยาวสูงสุด 4096 · ตรงกับ ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>จำเป็น

ตรงกับ ^(?:(?:\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)))$

inputDigeststringจำเป็น

ตรงกับ ^[0-9a-f]{64}$

statusstringจำเป็น

summary__schema0

แสดงพร็อพเพอร์ตี

__schema0

toolNamestringจำเป็น

ค่าที่อนุญาต:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

ค่าที่อนุญาต:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringจำเป็น

ความยาวต่ำสุด 1 · ความยาวสูงสุด 2048

retryablebooleanจำเป็น

okbooleanจำเป็น

toolNamestringจำเป็น

400

คำขอไม่ถูกต้อง ไม่รับพารามิเตอร์คิวรี หากตรวจสอบข้อมูลไม่ผ่าน อาจส่งคืนข้อผิดพลาดในรูปแบบของเครื่องมือ

อย่างน้อยหนึ่งรายการจาก:

TransportError

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

ToolError

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

ค่าที่อนุญาต:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringจำเป็น

ความยาวต่ำสุด 1 · ความยาวสูงสุด 2048

retryablebooleanจำเป็น

okbooleanจำเป็น

toolNamestringจำเป็น

401

ไม่มีข้อมูลยืนยันตัวตนแบบ bearer หรือข้อมูลไม่ถูกต้องหรือหมดอายุ

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

403

ข้อมูลยืนยันตัวตนไม่มีสิทธิ์ที่จำเป็น

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

404

API หรือเครื่องมือที่ขอไม่พร้อมใช้งาน

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

413

คำขอมีขนาดเกินจำนวนไบต์ที่กำหนด

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

ค่าที่อนุญาต:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringจำเป็น

ความยาวต่ำสุด 1 · ความยาวสูงสุด 2048

retryablebooleanจำเป็น

okbooleanจำเป็น

toolNamestringจำเป็น

429

เกินขีดจำกัดคำขอ สามารถลองใหม่ได้

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

503

API หรือบริการที่ประมวลผลคำขอไม่พร้อมใช้งาน

errorobjectจำเป็น

แสดงพร็อพเพอร์ตี

codestringจำเป็น

messagestringจำเป็น

retryablebooleanจำเป็น

คำขอ

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

การตอบกลับ

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