Llamar a una herramienta de solo lectura

Llama a una herramienta de solo lectura. Envía {input: {…}} según el esquema de la herramienta indicada en la ruta. Las solicitudes JSON tienen un límite de 65536 bytes. Una respuesta 200 puede contener ok:false.

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

Autorización

AuthorizationToken Bearer · headerobligatorio

Clave de API de Influence con permisos limitados o token de acceso OAuth compatible. No incluyas credenciales en las URL ni en los datos de entrada de las herramientas.

Parámetros de ruta

toolstringobligatorio

Nombre de herramienta devuelto por GET /api/v1/tools. La lista depende de los permisos de las credenciales; la presencia de un esquema no garantiza disponibilidad.

Cuerpo de la solicitud

obligatorioapplication/json

inputobjectobligatorio

Respuestas

200

Resultado de la herramienta; comprueba ok y error.

Una de:

object

okbooleanobligatorio

output__schema0obligatorio

Mostrar propiedades

__schema0

toolNamestringobligatorio

Valores permitidos:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

object

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

400

Solicitud no válida. No se aceptan parámetros de consulta. Los fallos de validación pueden usar el formato de error de la herramienta.

Una o más de:

TransportError

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

ToolError

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

401

Credencial bearer ausente, no válida o caducada.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

403

Las credenciales no tienen los permisos necesarios.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

404

La API o la herramienta solicitada no está disponible.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

413

La solicitud supera el límite de bytes.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

429

Se ha superado el límite de solicitudes. Se puede reintentar.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

503

La API o el servicio que ejecuta la operación no está disponible.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

Solicitud

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

Respuesta

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