बदलाव तैयार करें

बदलाव तैयार करने के लिए {input: {…}} भेजें. तैयार करने से पब्लिश करने की मंज़ूरी नहीं मिलती और पब्लिशिंग भी नहीं होती. तैयारी सफल होने पर confirmationCapability और expiresAt मिलते हैं; टूल विफल होने पर भी HTTP 200 मिल सकता है. JSON अनुरोधों की सीमा 65,536 बाइट है.

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

ऐक्सेस की अनुमति

AuthorizationBearer टोकन · headerज़रूरी

Influence की स्कोप वाली API कुंजी या समर्थित OAuth ऐक्सेस टोकन. URL और टूल के इनपुट में क्रेडेंशियल न डालें.

पाथ पैरामीटर

toolstringज़रूरी

GET /api/v1/tools से मिला टूल का नाम. डिस्कवरी में इस क्रेडेंशियल की अनुमतियों के हिसाब से टूल दिखते हैं; स्कीमा मौजूद होने से टूल की उपलब्धता साबित नहीं होती.

अनुरोध की बॉडी

ज़रूरीapplication/json

inputobjectज़रूरी

रिस्पॉन्स

200

तैयारी का नतीजा या टूल की विफलता.

इनमें से एक या अधिक:

PreparedTool

confirmationCapabilityConfirmationCapabilityज़रूरी

expiresAt से पहले यह मान X-Publish-Confirmation हेडर में वापस भेजें.

न्यूनतम लंबाई: 32 · अधिकतम लंबाई: 4096 · ^[A-Za-z0-9._~-]+$ से मेल खाना चाहिए

expiresAtstring<date-time>ज़रूरी

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ से मेल खाना चाहिए

inputDigeststringज़रूरी

^[0-9a-f]{64}$ से मेल खाना चाहिए

statusstringज़रूरी

summaryJsonValue | 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/prepare' \
  -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/prepare", {
  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/prepare",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}",
)

रिस्पॉन्स

{
  "confirmationCapability": "stringstringstringstringstringst",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inputDigest": "string",
  "status": "confirmation_required",
  "summary": "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
  }
}