Chuyển đến nội dung
Influence
Esc
↑↓di chuyển↵mở⌘Jxem trước

Chuẩn bị thao tác thay đổi

Chuẩn bị thao tác thay đổi bằng {input: {…}}. Bước chuẩn bị không phê duyệt hay thực hiện việc đăng. Chuẩn bị thành công trả về confirmationCapability và expiresAt; lỗi công cụ vẫn có thể dùng HTTP 200. Yêu cầu JSON có giới hạn 65.536 byte.

POST/api/v1/tools/{tool}/prepare
Ủy quyền
AuthorizationToken Bearer · headerbắt buộc

Khóa API Influence có phạm vi quyền cụ thể hoặc token truy cập OAuth được hỗ trợ. Không đưa thông tin xác thực vào URL hay đầu vào công cụ.

Tham số đường dẫn
toolstringbắt buộc

Tên công cụ do GET /api/v1/tools trả về. Việc khám phá được lọc theo quyền của thông tin xác thực này; có lược đồ không chứng minh công cụ khả dụng.

Nội dung yêu cầu
bắt buộcapplication/json
inputobjectbắt buộc
Các phản hồi
200

Kết quả chuẩn bị hoặc lỗi công cụ.

Ít nhất một phương án:
PreparedTool
confirmationCapabilityConfirmationCapabilitybắt buộc

Trả lại giá trị này trong tiêu đề X-Publish-Confirmation trước expiresAt.

độ dài tối thiểu 32 · độ dài tối đa 4096 · khớp ^[A-Za-z0-9._~-]+$
expiresAtstring<date-time>bắt buộc
khớp ^(?:(?:\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)))$
inputDigeststringbắt buộc
khớp ^[0-9a-f]{64}$
statusstringbắt buộc
summaryJsonValue | null
Hiện thuộc tính
Ít nhất một phương án:
string
string
number
number
boolean
boolean
null
null
JsonValue[]
Mảng gồm JsonValue
Tham chiếu vòng đến JsonValue.
object
object
toolNamestringbắt buộc
Cho phép:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
ToolError
errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
Cho phép:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringbắt buộc
độ dài tối thiểu 1 · độ dài tối đa 2048
retryablebooleanbắt buộc
okbooleanbắt buộc
toolNamestringbắt buộc
Cho phép:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
400

Yêu cầu không hợp lệ. Không chấp nhận tham số truy vấn. Lỗi kiểm tra dữ liệu của công cụ có thể dùng cấu trúc phản hồi lỗi của công cụ.

Ít nhất một phương án:
TransportError
errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
ToolError
errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
Cho phép:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringbắt buộc
độ dài tối thiểu 1 · độ dài tối đa 2048
retryablebooleanbắt buộc
okbooleanbắt buộc
toolNamestringbắt buộc
Cho phép:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
401

Thông tin xác thực Bearer bị thiếu, không hợp lệ hoặc hết hạn.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
403

Thông tin xác thực thiếu các quyền cần thiết.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
404

API dành cho máy hoặc công cụ được yêu cầu không khả dụng.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
413

Yêu cầu vượt giới hạn byte.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
Cho phép:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL
messagestringbắt buộc
độ dài tối thiểu 1 · độ dài tối đa 2048
retryablebooleanbắt buộc
okbooleanbắt buộc
toolNamestringbắt buộc
Cho phép:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool
429

Vượt giới hạn tần suất. Có thể thử lại khi gặp lỗi này.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
503

API hoặc quá trình thực thi phía sau API không khả dụng.

errorobjectbắt buộc
Hiện thuộc tính
codestringbắt buộc
messagestringbắt buộc
retryablebooleanbắt buộc
Yêu cầu
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"
  }
}'
Phản hồi
{
  "confirmationCapability": "stringstringstringstringstringst",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inputDigest": "string",
  "status": "confirmation_required",
  "summary": "string",
  "toolName": "adAuditQuote"
}