변경 준비

{input: {…}}로 변경 작업을 준비합니다. 준비는 게시를 승인하거나 실행하지 않습니다. 준비에 성공하면 confirmationCapability와 expiresAt이 반환되며 도구 실패도 HTTP 200을 사용할 수 있습니다. JSON 요청은 65,536바이트로 제한됩니다.

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

인증

AuthorizationBearer 토큰 · header필수

Influence의 범위 지정 API 키 또는 지원되는 OAuth 접근 토큰입니다. 인증 정보는 URL과 도구 입력에 넣지 마세요.

경로 매개변수

toolstring필수

GET /api/v1/tools에서 반환된 도구 이름입니다. 검색 결과는 이 인증 정보의 권한에 따라 걸러집니다. 스키마가 있다고 이용 가능하다고 볼 수는 없습니다.

요청 본문

필수application/json

inputobject필수

응답

200

준비 결과 또는 도구 실패입니다.

다음 중 하나 이상:

PreparedTool

confirmationCapabilityConfirmationCapability필수

expiresAt 전에 이 값을 X-Publish-Confirmation 헤더로 보내세요.

최소 길이: 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필수

summaryJsonValue | null

속성 보기

다음 중 하나 이상:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

JsonValue 배열

JsonValue에 대한 순환 참조입니다.

object

object

toolNamestring필수

허용 값:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobject필수

속성 보기

codestring필수

허용 값:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestring필수

최소 길이: 1 · 최대 길이: 2048

retryableboolean필수

okboolean필수

toolNamestring필수

400

잘못된 요청입니다. 쿼리 매개변수는 받지 않습니다. 도구 유효성 검사 실패는 도구 오류 응답 형식으로 반환될 수 있습니다.

다음 중 하나 이상:

TransportError

errorobject필수

속성 보기

codestring필수

messagestring필수

retryableboolean필수

ToolError

errorobject필수

속성 보기

codestring필수

허용 값:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_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필수

허용 값:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_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": "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
  }
}