Tool mit Lesezugriff aufrufen

Rufe ein Tool mit reinem Lesezugriff auf. Sende {input: {…}} gemäß dem Schema des Tools im Pfad. JSON-Anfragen sind auf 65536 Bytes begrenzt. Eine Antwort mit Status 200 kann ok:false enthalten.

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

Autorisierung

AuthorizationBearer-Token · headererforderlich

Influence-API-Schlüssel mit begrenzten Berechtigungen oder unterstütztes OAuth-Zugriffstoken. Zugangsdaten gehören weder in URLs noch in Tool-Eingaben.

Pfadparameter

toolstringerforderlich

Von GET /api/v1/tools gelieferter Tool-Name. Die Liste wird nach den Berechtigungen der Zugangsdaten gefiltert; ein vorhandenes Schema garantiert keine Verfügbarkeit.

Anfrageinhalt

erforderlichapplication/json

inputobjecterforderlich

Antworten

200

Tool-Ergebnis; prüfe ok und error.

Genau eines von:

object

okbooleanerforderlich

output__schema0erforderlich

Eigenschaften anzeigen

__schema0

toolNamestringerforderlich

Zulässige Werte:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

object

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

400

Ungültige Anfrage. Abfrageparameter werden nicht akzeptiert. Validierungsfehler können im Fehlerformat des Tools zurückgegeben werden.

Mindestens eines von:

TransportError

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

ToolError

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

401

Bearer-Zugangsdaten fehlen, sind ungültig oder abgelaufen.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

403

Den Zugangsdaten fehlen erforderliche Berechtigungen.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

404

Die API oder das angeforderte Tool ist nicht verfügbar.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

413

Die Anfrage überschreitet das Byte-Limit.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

429

Anfragelimit überschritten. Ein erneuter Versuch ist möglich.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

503

Die API oder der ausführende Dienst ist nicht verfügbar.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

Anfrage

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

Antwort

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