Chamar uma ferramenta sem confirmação

Chame uma ferramenta cujo descritor de descoberta tenha confirmation: “none”. Isso inclui ler dados e continuar um envio já autorizado. Envie {input: {…}} usando o esquema correspondente ao nome da ferramenta no caminho. Solicitações JSON têm limite de 65.536 bytes. Uma resposta 200 pode conter ok:false.

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

Autorização

AuthorizationToken Bearer · headerobrigatório

Chave de API do Influence com escopos definidos ou token de acesso OAuth compatível. Mantenha credenciais fora de URLs e da entrada das ferramentas.

Parâmetros de caminho

toolstringobrigatório

Nome de ferramenta retornado por GET /api/v1/tools. A descoberta é filtrada pelas permissões desta credencial; a presença de um esquema não comprova disponibilidade.

Corpo da solicitação

obrigatórioapplication/json

inputobjectobrigatório

Respostas

200

Resultado da ferramenta; inspecione ok e error.

Exatamente uma das opções:

object

okbooleanobrigatório

outputJsonValue | nullobrigatório

Mostrar propriedades

Uma ou mais das opções:

string

string

number

number

boolean

boolean

null

null

JsonValue[]

Array de JsonValue

Referência circular a JsonValue.

object

object

toolNamestringobrigatório

Valores permitidos:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsTool

ToolError

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

Valores permitidos:AI_SCHEDULING_LIMIT_REACHEDAI_SCHEDULING_UNAVAILABLEINVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobrigatório

comprimento mínimo: 1 · comprimento máximo: 2048

retryablebooleanobrigatório

okbooleanobrigatório

toolNamestringobrigatório

400

Solicitação inválida. Parâmetros de consulta não são aceitos. Falhas de validação da ferramenta podem usar a estrutura de erro da ferramenta.

Uma ou mais das opções:

TransportError

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

ToolError

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

comprimento mínimo: 1 · comprimento máximo: 2048

retryablebooleanobrigatório

okbooleanobrigatório

toolNamestringobrigatório

401

Credencial bearer ausente, inválida ou expirada.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

403

A credencial não tem as permissões necessárias.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

404

A API para automações ou a ferramenta solicitada está indisponível.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

413

A solicitação excede o limite de bytes.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

comprimento mínimo: 1 · comprimento máximo: 2048

retryablebooleanobrigatório

okbooleanobrigatório

toolNamestringobrigatório

429

Limite de solicitações excedido. É possível tentar novamente após este erro.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

503

A API ou o serviço responsável pela execução está indisponível.

errorobjectobrigatório

Mostrar propriedades

codestringobrigatório

messagestringobrigatório

retryablebooleanobrigatório

Solicitação

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

Resposta

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