Tumawag ng read-only na tool

Tumawag ng read-only na tool. Ipadala ang {input: {…}} ayon sa schema ng tool na nasa path. Hanggang 65536 bytes lang ang JSON request. Maaaring may ok:false ang response na 200.

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

Awtorisasyon

AuthorizationBearer token · headerkailangan

Influence API key na may takdang permissions o suportadong OAuth access token. Huwag ilagay ang credentials sa mga URL o tool input.

Mga parameter ng path

toolstringkailangan

Pangalan ng tool mula sa GET /api/v1/tools. Nakadepende ang listahan sa permissions ng credentials; hindi garantiya ng availability ang pagkakaroon ng schema.

Nilalaman ng request

kailanganapplication/json

inputobjectkailangan

Mga tugon

200

Resulta ng tool; tingnan ang ok at error.

Eksaktong isa sa:

object

okbooleankailangan

output__schema0kailangan

Ipakita ang mga property

__schema0

toolNamestringkailangan

Mga pinapayagang halaga:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

object

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

400

Hindi valid ang request. Hindi tinatanggap ang query parameters. Maaaring gumamit ng tool error format ang mga validation failure.

Isa o higit pa sa:

TransportError

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

ToolError

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

401

Wala, hindi valid, o expired ang bearer credentials.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

403

Kulang ang kinakailangang permissions ng credentials.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

404

Hindi available ang API o ang hiniling na tool.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

413

Lumampas sa byte limit ang request.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

Mga pinapayagang halaga:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringkailangan

minimum na haba: 1 · maximum na haba: 2048

retryablebooleankailangan

okbooleankailangan

toolNamestringkailangan

429

Lumampas sa request limit. Maaaring subukan ulit.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

503

Hindi available ang API o ang serbisyong nagpapatakbo ng operasyon.

errorobjectkailangan

Ipakita ang mga property

codestringkailangan

messagestringkailangan

retryablebooleankailangan

Request

curl -X POST 'https://influence.so/api/v1/tools/string/call' \
  -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/call", {
  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/call",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}",
)

Tugon

{
  "ok": true,
  "output": "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
  }
}