{ "api_info": { "title": "SCM (SEO Content Machine) API", "version": "1.0.0", "description": "Complete API documentation for SEO Content Machine - optimized for AI LLM consumption", "base_url": "http://localhost:8008", "authentication": { "type": "API Key", "methods": [ "query parameter: apikey", "body parameter: apikey" ], "optional": true, "description": "API key authentication is optional but required for certain endpoints like blog settings" }, "response_format": { "standard_response": { "success": "boolean - true for success, false for error", "message": "string - error message or null", "result": "any - the actual response data", "taskId": "string - present for task-related operations" } } }, "endpoints": { "core": { "GET /": { "description": "API server status and information", "authentication": "none", "parameters": {}, "response": { "success": true, "message": null, "result": "HTML page with API links" }, "examples": [ { "request": "GET http://localhost:8008/", "response": "HTML welcome page with API documentation links" } ] }, "GET /test": { "description": "Simple test endpoint to verify API connectivity", "authentication": "none", "parameters": {}, "response": { "success": true, "message": null, "result": null }, "examples": [ { "request": "GET http://localhost:8008/test", "response": { "success": true, "message": null, "result": null } } ] } }, "content_processing": { "POST /spin": { "description": "Spin text content using the built-in spinner", "authentication": "optional", "parameters": { "body": { "text": { "type": "string", "required": true, "description": "Text to spin" }, "csvprotectedwords": { "type": "string", "required": false, "description": "Comma-separated protected words" } } }, "response": { "success": true, "message": null, "result": "string - spun text" }, "examples": [ { "request": { "url": "POST http://localhost:8008/spin", "body": { "text": "Hello world", "csvprotectedwords": "world" } }, "response": { "success": true, "message": null, "result": "Hello {world|planet|earth}" } } ] }, "GET /aboutme": { "description": "Generate 'about me' text for a keyword", "authentication": "optional", "parameters": { "query": { "keyword": { "type": "string", "required": true, "description": "Keyword to generate about me text for" } } }, "response": { "success": true, "message": null, "result": "string - generated about me text" }, "examples": [ { "request": "GET http://localhost:8008/aboutme?keyword=coffee", "response": { "success": true, "message": null, "result": "Coffee is a brewed drink prepared from roasted coffee beans..." } } ] } }, "ai_services": { "GET /ai-services": { "description": "Get list of available AI services", "authentication": "optional", "parameters": {}, "response": { "success": true, "message": null, "result": "array of strings - AI service names" }, "examples": [ { "request": "GET http://localhost:8008/ai-services", "response": { "success": true, "message": null, "result": [ "azure ai", "claude ai", "deepinfra", "deepseek", "google gemini", "groq ai", "open ai", "openrouter", "straico", "webhook 1", "webhook 2", "scm" ] } } ] }, "GET /ai-prompt-templates": { "description": "Get available AI prompt templates", "authentication": "optional", "parameters": {}, "response": { "success": true, "message": null, "result": "array of prompt template objects" }, "examples": [ { "request": "GET http://localhost:8008/ai-prompt-templates", "response": { "success": true, "message": null, "result": [ { "id": 1, "name": "SEO Article", "template": "Write an SEO-optimized article about {keyword}..." } ] } } ] } }, "blog_management": { "POST /blog-settings/create": { "description": "Create new blog settings", "authentication": "required", "parameters": { "body": { "type": "array", "description": "Array of blog objects to create", "items": { "url": "string - blog URL", "username": "string - login username", "password": "string - login password", "group": "string - optional group name" } } }, "response": { "success": true, "message": null, "result": "array - created blog objects with IDs" } }, "GET /blog-settings": { "description": "Get all blog settings", "authentication": "required", "parameters": { "query": { "id": { "type": "string", "required": false, "description": "Specific blog ID to retrieve" } } }, "response": { "success": true, "message": null, "result": "array/object - blog settings" } }, "POST /blog-settings/update": { "description": "Update existing blog settings", "authentication": "required", "parameters": { "body": { "type": "array", "description": "Array of blog objects to update" } }, "response": { "success": true, "message": null, "result": null } }, "GET /blog-settings/delete/:id": { "description": "Delete a blog setting", "authentication": "required", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Blog ID to delete" } } }, "response": { "success": true, "message": "sites remaining", "result": "number - remaining blog count" } } }, "task_management": { "GET /task/find/": { "description": "Find and filter tasks", "authentication": "optional", "parameters": { "query": { "type": { "type": "string", "required": false, "description": "Task type filter (e.g., 'article creator')" }, "group": { "type": "string", "required": false, "description": "Group name filter" }, "name": { "type": "string", "required": false, "description": "Task name filter (regex supported)" }, "status": { "type": "string", "required": false, "description": "Task status filter" } }, "body": { "query": { "type": "object", "required": false, "description": "Additional MongoDB query filters" }, "projection": { "type": "object", "required": false, "description": "MongoDB projection object" } } }, "response": { "success": true, "message": null, "result": "array - task objects with data, name, status, _id" }, "examples": [ { "request": "GET http://localhost:8008/task/find/?type=article%20creator", "response": { "success": true, "message": null, "result": [ { "_id": "507f1f77bcf86cd799439011", "name": "article creator", "status": "running", "data": { "jobName": "My Article Task", "groupName": "Content Group" } } ] } } ] }, "GET /task/data/:id": { "description": "Get full task configuration data", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID" } } }, "response": { "success": true, "message": null, "result": "object - complete task configuration", "taskId": "string - task ID" } }, "POST /task/data/:id": { "description": "Update task configuration data", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID" } }, "body": { "type": "object", "description": "Partial task configuration to update (merged with existing)" } }, "response": { "success": true, "message": null, "result": "object - updated task configuration", "taskId": "string - task ID" } }, "GET /task/status/:id": { "description": "Get task status information", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID" } } }, "response": { "success": true, "message": null, "result": "array - status objects with group, name, type, status, id" } }, "GET /task/delete/:id": { "description": "Delete a task and its data", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID to delete" } } }, "response": { "success": true, "message": null, "result": null } }, "GET /task/run/:id": { "description": "Start/run a task", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID to run" } } }, "response": { "success": true, "message": null, "result": null, "taskId": "string - task ID" } }, "GET /task/abort/:id": { "description": "Abort/stop a running task", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID to abort" } } }, "response": { "success": true, "message": null, "result": null, "taskId": "string - task ID" } }, "GET /task/groups": { "description": "Get all task group names", "authentication": "optional", "parameters": {}, "response": { "success": true, "message": null, "result": "array of strings - group names" } } }, "task_creation": { "GET /create/articlecreator": { "description": "Create a new article creator task", "authentication": "optional", "parameters": {}, "response": { "success": true, "message": null, "result": { "id": "string - new task ID", "data": "object - task configuration" }, "taskId": "string - task ID" } }, "GET /create/:task": { "description": "Create a new task of specified type", "authentication": "optional", "parameters": { "path": { "task": { "type": "string", "required": true, "description": "Task type identifier", "enum": [ "article creator", "article downloader", "bulk translator", "google scraper", "google maps scraper", "keyword finder", "mail merge", "post emailer", "post uploader", "rss scraper", "url finder", "wayback scraper", "web scraper", "web crawler", "writing assistant", "wp xml generator", "youtube sub scraper" ], "examples": [ "article creator - Create articles from keywords", "writing assistant - AI-powered writing assistant", "google scraper - Scrape Google search results", "web scraper - Scrape website content", "post uploader - Upload content to blogs" ] } } }, "response": { "success": true, "message": null, "result": { "id": "string - new task ID", "data": "object - task configuration" }, "taskId": "string - task ID" } } }, "content_access": { "GET /task/cache/:id": { "description": "Get cached content for a task", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID" } }, "query": { "keyword": { "type": "string", "required": false, "description": "Specific keyword cache to retrieve" } } }, "response": { "success": true, "message": null, "result": "object - cached content with paragraphs, images, etc." } }, "GET /task/content/:id/*": { "description": "Get generated content files for a task", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID" }, "path": { "type": "string", "required": false, "description": "Subfolder path within task output" } } }, "response": { "success": true, "message": null, "result": { "subFolders": "array - subfolder objects", "content": "array - file content objects" } } } }, "task_operations": { "GET /task/duplicate/:id": { "description": "Duplicate an existing task", "authentication": "optional", "parameters": { "path": { "id": { "type": "string", "required": true, "description": "Task ID to duplicate" } } }, "response": { "success": true, "message": null, "result": "string - new task ID" } }, "POST /duplicate": { "description": "Duplicate a task and optionally change keywords", "authentication": "optional", "parameters": { "body": { "id": { "type": "string", "required": true, "description": "Task ID to duplicate" }, "keywords": { "type": "array", "required": false, "description": "New keywords for duplicated task" } } }, "response": { "success": true, "message": null, "result": "string - new task ID" } } } }, "task_types": { "article creator": { "description": "Creates articles from keywords using various content sources", "task_parameters": { "articleUseCache": false, "articleKeywordsFile": [""], "articleTemplateInfo": {"name": "article html", "filename": "article html.template.json"}, "articleUseGenerator": false, "articleUseAiWriter": true, "aiWriterModel": "", "aiWriterScrapedParagraphCountTo": 0, "aiWriterScrapedParagraphCountFrom": 0, "aiPromptSetIds": [1], "aiWriterVariablesFile": [""], "aiWriterTemplateFile": [""], "aiWriterArticleCount": 1, "aiWriterFilenameString": "%keyword% %number%", "articleScraperThreadCount": 10, "articleUseSpiffer": false, "articleUseAFSpiffer": false, "articleAFSpifferImageChance": 0, "articleAFSpifferVideoChance": 0, "articleAFSpifferArticleCount": 5, "articleCombinationType": "one keyword", "articleSpifferDirectory": "", "articleCountType": "Required", "articleCountRequired": 10, "articleUseSpinner": true, "articleSpinTitles": true, "articleSpinSentences": true, "articleSpinSubHeadings": true, "articleSpinQuestions": true, "articleSpinAnswers": true, "articleSpinner": "none", "articleSpinnerAiModel": "none", "articleSpinnerMaxCharacters": 0, "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "articleProtectedTerms": "", "articleGoogleCountry": "Current Region:English", "searchEngine": 0, "searchType": "search", "articleAiUseSearch": false, "urlLimitResults": 25, "articleUrlFilterFile": [""], "articleVariations": 1, "contentFilterBayesFilename": null, "contentExportTo": "folder", "googleSpreadsheetId": "", "googleSpreadsheetName": "", "googleSheetId": "", "googleClearSheetData": false, "articleOutputType": "spintax", "articleOutputFilenameString": "%keyword% %number%", "regexSampleTextFile": [""], "articleJunkFilterFile": [""], "articleSafeFilterFile": [""], "articleReplaceFilterFile": [""], "articleCustomTitlesFile": [""], "articleScrapedTitlesMinLength": 3, "articleSubheadingMinLength": 3, "articleInsertOptionTitle": 2, "articleTitleString": "%title%", "articleSubheadingString": "%subheading%", "articleCategories": ["anonymous", "uncategorized", "misc", "general", "other"], "articleCustomContent": {}, "paragraphCountFrom": 5, "paragraphCountTo": 10, "linkSets": {}, "articleUseImages": false, "imageInsert": { "ImageSearchString": "%keyword%", "FloatLeft": false, "FloatRight": false, "Centre": true, "ImageWidth": 600, "Source": 0, "ImageAltTags": 1, "imageCustomAltTagsFile": [""], "InsertAtStartOfBody": false, "InsertAtEndOfBody": false, "InsertAtParagraphLocation": "", "FrequencyFrom": 1, "FrequencyTo": 1, "ImageFormatString": "\"%alt%\"", "ImageUrls": [], "SuggestedAltTags": [], "ResultLimit": 50, "InsertType": "hotlink", "UseAI": false, "UseAICount": 1, "AiImageModel": "dall-e", "TimTags": 3, "UseBing": true, "UseYoutube": false, "UseCreativeCommons": false, "UseUnsplash": false, "UseBingCC": false, "UsePexelsApi": false, "UsePixabayApi": false, "UsePixaBay": false, "UseCustomImages": true, "imageCustomImagesFile" : [""] }, "articleUseVideos": false, "videoInsert": { "Source": 0, "Output": 0, "Username": "", "Channel": "", "SearchString": "%keyword%", "videoCustomVideosFile": [""], "videoExtraYoutubeIdsFile": [""], "UseYoutubeKeyword": true, "UseYoutubeChannel": false, "UseYoutubeUsername": false, "ResultLimit": 50, "InsertAtStartOfBody": false, "InsertAtEndOfBody": false, "FrequencyFrom": 1, "FrequencyTo": 1, "InsertString": "
\n\n
" }, "articleUseHeadings": false, "headingInsert": { "HeadingTags": "h2,h3", "FrequencyFrom": 2, "FrequencyTo": 3, "headingsCustomHeadingsFile": [""], "InsertOption": 2, "InsertToc": false, "TocInsertChance": 100, "TocHeading": "Content", "TocStyle": "background: #f9f9f9;border: 1px solid #aaa;display: table;margin-bottom: 1em;padding: 1em;width: 350px;", "TocTitleStyle": "font-weight: 700;text-align: center;" }, "articleUseList": false, "listInsert": { "ListStartTag": "", "ItemStartTag": "
  • ", "ItemEndTag": "
  • ", "ItemCountFrom": 3, "ItemCountTo": 6, "InsertCountFrom": 1, "InsertCountTo": 1, "InsertChance": 100, "CustomListItemsFile": [""] }, "articleUseTokenInsert": false, "tokenInsert": { "InsertCountFrom": 1, "InsertCountTo": 1, "InsertTokenFile": [""] }, "articleUseQna": false, "qnaInsert": { "InsertCountFrom": 1, "InsertCountTo": 1, "InsertAtEndOfBody": false, "QnaMaxCount": 6, "QnaSearchString": "%keyword%", "InsertString": "
    \n

    %question%

    \n
    \n

    %answer%

    \n
    \n
    " }, "articleUseArticleForge": false, "articleForgeArticleCount": 5, "articleUseGoogleMaps": false, "googleMapsInsert": { "MapQuery": "", "InsertChance": 100, "MapEmbedCode": "
    " }, "articleUseGoogleDirections": false, "googleDirectionsInsert": { "StartingLocation": "", "DestinationLocation": "", "InsertChance": 100, "MapEmbedCode": "
    \n
    " }, "articleUseGoogleMapDirections": false, "googleMultiDirectionsInsert": { "Destination": "", "OriginCount": 1, "RadiusKms": 10, "TravelDriving": true, "TravelTwowheeler": false, "TravelWalking": false, "TravelCycling": false, "TravelTransit": false, "MapEmbedKeywordsFile": [""], "MapDestinationsFile": [""], "MapEmbedCode": "
    \n
    " }, "articleUseHtmlInsert": false, "htmlInsert": { "InsertChance": 100, "HtmlInsertCodeFile": [""] }, "articleUseCategoryInsert": false, "categoryInsert": { "StartTag": "", "EndTag": "", "CategoryInsertFile": [""] }, "articleUseBlogInsert": false, "blogInsert": { "StartTag": "", "EndTag": "", "BlogInsertFile": [""] }, "articleUseSeoNap": false, "seoNapInsert": { "SeoNapHtmlCodeFile": [""], "Name": "", "Email": "", "Telephone": "", "StreetAddress": "", "AddressLocality": "", "AddressRegion": "", "AddressCountry": "", "PostalCode": "" }, "articleUseJavascriptInsert": false, "javascriptInsert": { "InsertChance": 100, "JavascriptInsertCodeFile": [""] }, "articleUsePageRedirectInsert": false, "pageRedirectInsert": { "InsertChance": 100, "RedirectDate": "now", "Delay": 2, "Url": "", "PageRedirectUrlFile": [""] }, "articleUseProductInfo": false, "productInfoInsert": { "@context": "https://schema.org/", "@type": "Product", "name": "", "image": [], "description": "", "sku": "", "mpn": "", "brand": { "@type": "Brand", "name": "" }, "review": { "@type": "Review", "reviewRating": { "@type": "Rating", "ratingValue": "", "bestRating": "" }, "author": { "@type": "Person", "name": "" } }, "aggregateRating": { "@type": "AggregateRating", "ratingValue": "", "reviewCount": "", "bestRating": "" }, "offers": { "@type": "AggregateOffer", "offerCount": "", "lowPrice": "", "highPrice": "", "priceCurrency": "" } }, "articleUseLocalBusiness": false, "localBusinessInsert": { "@context": "https://schema.org/", "@type": "Store", "name": "", "image": [], "priceRange": "", "servesCuisine": "", "telephone": "", "address": { "@type": "PostalAddress", "streetAddress": "", "addressLocality": "", "addressRegion": "", "postalCode": "", "addressCountry": "" } }, "articleUseNews": false, "newsInsert": { "InsertCountFrom": 1, "InsertCountTo": 1, "InsertString": "
    \n

    %title%

    \n

    %desc%

    \n

    Posted: %date% [source]

    \n
    ", "SearchString": "%keyword%" }, "articleUseRss": false, "rssInsert": { "InsertCountFrom": 1, "InsertCountTo": 1, "InsertString": "
    \n

    %title%

    \n

    %desc%

    \n

    Posted: %date% [source]

    \n
    ", "RssUrl": "" }, "articleAiUseLocal": false, "articleLocalContent": "", "wpCategoryFile": [""], "jobName": "", "groupName": "", "jobOutputFolder": "%project_folder%", "jobCron": "", "chainJobId": "", "childJobId": "" } }, "article downloader": { "description": "Download articles from specified URLs", "task_parameters": { "cssSelector": "h1,h2,p", "unwrapTagsSelector": "", "removeTagsSelector": "", "removeEmptyTagsSelector": "", "junkWordsFile" : [""], "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerMaxCharacters": 0, "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerAiModel": "none", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "articleReplaceFilterFile" : [""], "articleProtectedTerms": "", "articleUseTranslator": true, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "removeHtml": false, "combineFiles": false, "ignoreArticleSizeLessThan": 0, "pHeadTag": "", "pEndTag": "", "downloadUrlsFile": [""], "urlsFilepath": "", "filenameString": "%file_name%.txt", "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "writing assistant": { "description": "AI-powered writing assistant for content creation", "task_parameters": { "articleKeywords": "", "articleGoogleCountry": "Current Region:English", "searchEngine": 0, "searchType": "search", "articleUseQna": true, "qnaInsert": { "InsertCountFrom": 1, "InsertCountTo": 10, "InsertString": "", "QnaMaxCount": 15 }, "articleUrlsFile": [""], "articleJunkFilterFile": [""], "articleSafeFilterFile": [""], "articleReplaceFilterFile": [""], "urlLimitResults": "100", "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "articleScraperThreadCount": 10 } }, "url finder": { "description": "Find URLs related to keywords", "task_parameters": { "articleKeyword": "", "articleKeywordsFilename": "", "articleGoogleCountry": "Current Region:English", "searchType": "search", "searchEngine": 0, "urlLimitResults": 100, "urlJunkWordsFile": [""], "jobOutputFolder": "%project_folder%", "jobName": "My Url List", "groupName": "", "jobCron": "", "chainJobId": "" } }, "post uploader": { "description": "Upload content to blogs/websites", "task_parameters": { "blogIds": [], "blogIdsFile": [""], "articleFolder": "", "postUseToday": false, "postSharedSchedule": false, "postStartDate": "now", "postIntervalFrom": "1", "postIntervalTo": "3", "postsPerDay": "1", "articleTitle": "

    ", "articleCategory": "", "articleTags": "auto tags", "postFeaturedImage": false, "postDeleteOnUpload": false, "postCheckTitleIsUnique": true, "postDraft": false, "postType": "posts", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "parentJobId": "", "parentJobName": "", "jobOutputFolder": "%project_folder%" } }, "google scraper": { "description": "Scrape Google search results", "task_parameters": { "keywordsFile": [""], "urlLimitResults": 10, "wordMinimum": 300, "wordMaximum": 9999, "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerAiModel": "none", "articleSpinnerMaxCharacters": 0, "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "pageScraperThreadCount": 5, "articleProtectedTerms": "", "articleUseTranslator": true, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "articleGoogleCountry": "Current Region:English", "urlJunkWordsFile": [""], "searchType": "search", "searchEngine": 0, "removeHtml": false, "templateCodeFile": [""], "pHeadTag": "", "pEndTag": "", "articleReplaceFilterFile": [""], "cssSelector": "h1,h2,p", "removeTagsSelector": "", "unwrapTagsSelector": "", "junkWordsFile": [""], "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "web scraper": { "description": "Scrape content from websites", "task_parameters": { "urlsFile": [""], "rulesFile": [""], "macroTemplateFile": [""], "combineFiles": false, "filenameString": "%file_name%", "csvFilenameString": "%task_name%", "previewUrl": "https://en.wikipedia.org/wiki/Special:Random", "downloadImages": false, "contentExportTo": "csv", "customCookiesFile" : [""], "googleSpreadsheetId": "", "googleSpreadsheetName": "", "googleSheetId": "", "googleClearSheetData": false, "pagerMaxCount": 10, "pagerUrlString": "", "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerAiModel": "none", "articleSpinnerMaxCharacters": 0, "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "articleProtectedTerms": "", "dynamicPageScraperThreadCount": 1, "articleUseTranslator": true, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "unwrapHtmlTag": "", "removeHtmlTag": "", "removeIdTag": "", "removeClassTag": "", "removeAttribute": "", "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "web crawler": { "description": "Crawl websites for content and links", "task_parameters": { "maxDepth": 1, "maxRequest": -1, "urlsFile": [""], "allowLinksFile": [""], "ignoreLinksFile": [""], "crawlerThreadCount": 5, "filenameString": "%url%.txt", "jobOutputFolder": "%project_content_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "wayback scraper": { "description": "Scrape archived content from Wayback Machine", "task_parameters": { "domain": "", "domains": "", "includeFilter": "", "excludeFilter": "", "startDate": "", "endDate": "", "removeHtml": false, "pHeadTag": "", "pEndTag": "", "articleReplaceFilterFile": [""], "cssSelector": "html", "unwrapTagsSelector": "", "removeTagsSelector": "", "removeEmptyTagsSelector": "", "junkWordsFile" : [""], "workerCount": 5, "jobOutputFolder": "%project_content_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "keyword finder": { "description": "Find related keywords and long-tail phrases", "task_parameters": { "articleKeyword": "", "articleKeywordsFile": [""], "keywordJunkWordsFile": [""], "keywordRequireWordsFile": [""], "keywordResultsFile": [""], "jobMode": "singleKeyword", "articleGoogleCountry": "Current Region:English", "searchType": "search", "articleUseQna": true, "qnaInsert": { "QnaMaxCount": 20 }, "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "jobOutputFolder": "%project_folder%" } }, "bulk translator": { "description": "Translate content between languages", "task_parameters": { "articlesFolder": "", "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerAiModel": "none", "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "articleSpinnerMaxCharacters": 0, "articleProtectedTerms": "", "articleUseTranslator": true, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "articleGoogleCountry": "", "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "mail merge": { "description": "Merge CSV data with email/content templates", "task_parameters": { "csvFilename": "", "customColumnsFile" : [""], "templateFilename": "", "fileName": "merge %number%.txt", "csvFileName": "ai csv merge.csv", "articleOutputType": "spintax", "contentExportTo": "csv", "aiWriterModel": "", "googleSpreadsheetId": "", "googleSpreadsheetName": "", "googleSheetId": "", "googleClearSheetData": false, "csvMaxRows": -1, "jobOutputFolder": "%project_folder%", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "" } }, "post emailer": { "description": "Send content via email", "task_parameters": { "jobName": "", "groupName": "", "articleFolder": "", "blogIds": [], "blogIdsFile": [""], "smtpHost": "", "smtpPort": "", "smtpSecure": true, "smtpUser": "", "smtpPassword": "", "articleTitle": "

    ", "postUseToday": false, "postSharedSchedule": false, "postStartDate": "now", "postIntervalFrom": 1, "postIntervalTo": 1, "postsPerDay": 1, "jobCron": "*/15 * * * *", "jobOutputFolder": "%project_folder%" } }, "rss scraper": { "description": "Scrape RSS feeds for content", "task_parameters": { "urlsFile": [""], "urlLimit": -1, "filenameString": "%title%.txt", "cssSelector": "h2, p", "removeTagsSelector": "script", "unwrapTagsSelector": "", "articleReplaceFilterFile" : [""], "articleJunkFilterFile" : [""], "articleSafeFilterFile" : [""], "removeAttribute": "", "removeHtml": false, "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerWordSpinner": "none", "articleSpinnerAiModel": "", "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "articleTranslator": "none", "articleTranslatorFrom": "", "articleTranslatorTo": "", "articleTranslatorTo1": "", "articleTranslatorTo2": "", "contentExportTo": "folder", "articleProtectedTerms": "", "templateCodeFile" : [""], "pHeadTag": "", "pEndTag": "", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "jobOutputFolder": "%project_folder%" } }, "youtube sub scraper": { "description": "Scrape YouTube channel/subscriber data", "task_parameters": { "urlsFile": [""], "filenameString": "%title%.txt", "languageCode": "zz", "articleReplaceFilterFile" : [""], "articleUseSpinner": true, "articleOutputType": "spintax", "articleSpinner": "none", "articleSpinnerTranslateSource": "en", "articleSpinnerTranslateTarget": "en", "articleSpinnerAiModel": "none", "articleSpinnerRemoveOriginal": false, "articleSpinnerAiRewriteCount": 1, "resultLimit": 10, "articleProtectedTerms": "", "templateCodeFile" : [""], "pHeadTag": "

    ", "pEndTag": "

    ", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "jobOutputFolder": "%project_folder%" } }, "google maps scraper": { "description": "Scrape Google Maps data", "task_parameters": { "contentExportTo": "csv", "googleSpreadsheetId": "", "googleSpreadsheetName": "", "googleSheetId": "", "googleClearSheetData": false, "csvClearData": true, "contactSearchList": "/, contact, contact-us", "queriesTextFile" : [""], "resultsLimit": 10, "mapLanguage": "zz", "embedString": "", "embedStringFile" : [""], "useName": true, "useCategory": true, "useClaimed": true, "useRating": true, "useNumberOfReviews": true, "useOpeningHours": true, "useAbout": true, "usePlusCode": true, "useGoogleMapsUrl": true, "useAddress": true, "useLat": true, "useLong": true, "usePhone": true, "useWebsite": true, "useDomain": true, "useEmail": true, "useWebsiteLogoUrl": true, "useWebsiteMeta": true, "useFacebook": true, "useYoutube": true, "useInstagram": true, "useLinkedin": true, "useX": true, "useImageUrl": true, "useQueryUrl": true, "useMapsEmbedCode": true, "useReview": true, "reviewCount": 10, "googleMapsBrowserThreadCount": 2, "uniqueWebsite": false, "uniqueDomain": false, "uniqueLatLong": false, "uniquePlusCode": false, "ignorePlaceWithWebsite": false, "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "jobOutputFolder": "%project_content_folder%" } }, "wp xml generator": { "description": "Generate WordPress XML import files", "task_parameters": { "blogIds": [], "articleFolder": "", "postUseToday": false, "postSharedSchedule": false, "postStartDate": "now", "postIntervalFrom": "1", "postIntervalTo": "3", "postsPerDay": "1", "postDraft": false, "articleTitle": "

    ", "articleCategory": "", "articleTags": "auto tags", "jobName": "", "groupName": "", "jobCron": "", "chainJobId": "", "jobOutputFolder": "" } } }, "error_responses": { "authentication_required": { "success": false, "message": "You must pass an apikey parameter eg: {\"apikey\": \"#yourkey#\"} or ?apikey=#yourkey#", "result": null }, "task_not_found": { "success": false, "message": "Was unable to find task of id {id}", "result": null }, "invalid_parameters": { "success": false, "message": "Missing or invalid parameters", "result": null } }, "usage_examples": { "create_and_run_article_task": [ "1. Create article creator task: GET /create/articlecreator", "2. Update task settings: POST /task/data/{id} with article settings", "3. Run the task: GET /task/run/{id}" ], "get_task_results": [ "1. Check task status: GET /task/status/{id}", "2. Get cached content: GET /task/cache/{id}", "3. Get generated files: GET /task/content/{id}" ], "batch_operations": [ "1. Find tasks by type: GET /task/find/?type=article%20creator", "2. Update multiple tasks with same settings", "3. Run all tasks: Loop through task IDs with GET /task/run/{id}" ] } }