קריאה לכלי ללא שלב אישור

קראו לכלי שבמתאר שלו מגילוי הכלים מופיע confirmation: “none”. הדבר כולל קריאת נתונים והמשך העלאה שכבר ניתנה הרשאה לביצועה. שלחו {input: {…}} לפי הסכמה שמתאימה לשם הכלי בנתיב. בקשות JSON מוגבלות ל־65,536 בתים. תגובה בקוד 200 יכולה להכיל ok:false.

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

הרשאה

Authorizationאסימון Bearer · headerחובה

מפתח API של Influence עם הרשאות מוגדרות, או אסימון גישה נתמך של OAuth. אל תכללו פרטי גישה בכתובות URL או בקלט לכלי.

פרמטרים בנתיב

toolstringחובה

שם הכלי שהוחזר ב־GET /api/v1/tools. גילוי הכלים מסונן לפי ההרשאות של פרטי הגישה האלה; עצם הופעת הסכמה אינה מוכיחה שהכלי זמין.

גוף הבקשה

חובהapplication/json

inputobjectחובה

תגובות

200

תוצאת הכלי; בדקו את ok ואת error.

אחת בלבד מהאפשרויות:

object

okbooleanחובה

outputJsonValue | 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חובה

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חובה

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

תגובה

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