[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8},"actionData","errors","root",{"_9":180,"_181":-5,"_182":-5,"_183":43,"_184":185,"_186":187,"_188":189,"_190":191,"_192":193,"_194":19,"_195":19,"_196":19,"_197":198,"_199":200,"_201":202,"_203":204,"_205":-5,"_206":207,"_208":209},"routes/help/($lang)",{"_9":10,"_11":12,"_13":-7,"_14":15,"_16":17,"_18":19},"metatags",[167,168,169,170,171,172,173,174,175,176,177,178],"kb",{"_21":138,"_23":139,"_25":140,"_141":142,"_27":143,"_29":144,"_31":145,"_146":43,"_147":104,"_148":149,"_150":151,"_152":45,"_153":154,"_155":156,"_157":158,"_55":32,"_9":10},"search","categories",[96],"featured",[20],"isAdmin",false,{"_21":22,"_23":24,"_25":26,"_27":28,"_29":30,"_31":32,"_33":34,"_35":36,"_37":36,"_38":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":51,"_52":-5,"_53":54,"_55":32,"_9":56},"id","cllqoaqni000rol7v18xvg2si","createdAt",["D",1692972807535],"updatedAt",["D",1696599436576],"slug","authentication","title","Authentication","description","","order",2,"contentDraft","

To authenticate with the Autom API, add the header x-api-key to your request.

You can find your API key on your dashboard.

Request

The host is autom.dev
All requests should be made with HTTPS
All of our endpoints accept the POST method

You are required to add the header Content-Type: application/json

curl -X POST \\\n -H \"Content-Type: application/json\" \\\n -H \"x-api-key: your_api_key\" \\\n -d '{\n    \"query\": \"home\",\n    \"page\": 1,\n    \"gl\": \"us\",\n    \"hl\": \"en\",\n    \"google_domains\": \"google.com\"\n}' \\\n \"https://autom.dev/api/v1/google/search\"

Response

All the response will be in the JSON format.
Each response will always contain an error property: false if the request was successful, true otherwise
Response codes: see error handling page for more information.

Example of a successful response

{\n    \"search_parameters\": {\n        \"q\": \"home\",\n        \"google_domain\": \"google.com\",\n        \"page\": 1,\n        \"gl\": \"us\",\n        \"hl\": \"en\",\n        \"engine\": \"google\"\n    },\n    \"organic_results\": [\n        {\n            \"position\": 1,\n            \"title\": \"The Home Depot\",\n            \"link\": \"https://www.homedepot.com/\",\n            \"domain\": \"www.homedepot.com\",\n            \"displayed_link\": \"https://www.homedepot.com\",\n            \"snippet_matched\": [\n                \"home\"\n            ],\n            \"snippet\": \"Shop online for all your home improvement needs: appliances, bathroom decorating ideas, kitchen remodeling, patio furniture, power tools, bbq grills, ...\"\n        },\n        {\n            \"position\": 2,\n            \"title\": \"At Home is The Home & Holiday Superstore\",\n            \"link\": \"https://www.athome.com/\",\n            \"domain\": \"www.athome.com\",\n            \"displayed_link\": \"https://www.athome.com\",\n            \"snippet_matched\": [],\n            \"snippet\": null\n        },\n        {\n            \"position\": 3,\n            \"title\": \"Home (2015)\",\n            \"link\": \"https://www.imdb.com/title/tt2224026/\",\n            \"domain\": \"www.imdb.com\",\n            \"displayed_link\": \"https://www.imdb.com › title\",\n            \"snippet_matched\": [],\n            \"snippet\": null\n        },\n        {\n            \"position\": 4,\n            \"title\": \"Google Home: Smart home automation from Google\",\n            \"link\": \"https://home.google.com/welcome/\",\n            \"domain\": \"home.google.com\",\n            \"displayed_link\": \"https://home.google.com › ...\",\n            \"snippet_matched\": [\n                \"home\"\n            ],\n            \"snippet\": \"From smart lights to smart locks, Google Home unites devices and services from Google and your favorite brands to build a personalized smart home to help ...\"\n        },\n        {\n            \"position\": 5,\n            \"title\": \"Home Definition & Meaning\",\n            \"link\": \"https://www.dictionary.com/browse/home\",\n            \"domain\": \"www.dictionary.com\",\n            \"displayed_link\": \"https://www.dictionary.com › browse\",\n            \"snippet_matched\": [],\n            \"snippet\": \"a house, apartment, or other shelter that is the usual residence of a person, family, or household. the place in which one's domestic affections are centered.\"\n        },\n        {\n            \"position\": 6,\n            \"title\": \"Home Official Trailer #1 (2015) - YouTube\",\n            \"link\": \"https://www.youtube.com/watch?v=MyqZf8LiWvM\",\n            \"domain\": \"www.youtube.com\",\n            \"displayed_link\": \"https://www.youtube.com › watch\",\n            \"snippet_matched\": [],\n            \"snippet\": null\n        }\n    ]\n}

","contentPublished","contentPublishedAsText","To authenticate with the Autom API, add the header x-api-key to your request.\n\nYou can find your API key on your dashboard [https://autom.dev/login].\n\n\nREQUEST\n\n * The host is autom.dev\n\n * All requests should be made with HTTPS\n\n * All of our endpoints accept the POST method\n\nYou are required to add the header Content-Type: application/json\n\ncurl -X POST \\\n -H \"Content-Type: application/json\" \\\n -H \"x-api-key: your_api_key\" \\\n -d '{\n \"query\": \"home\",\n \"page\": 1,\n \"gl\": \"us\",\n \"hl\": \"en\",\n \"google_domains\": \"google.com\"\n}' \\\n \"https://autom.dev/api/v1/google/search\"\n\n\nRESPONSE\n\n * All the response will be in the JSON format.\n\n * Each response will always contain an error property: false if the request was successful, true otherwise\n\n * Response codes: see error handling page [https://autom.dev/help/articles/status-code] for more information.\n\n\nEXAMPLE OF A SUCCESSFUL RESPONSE\n\n{\n \"search_parameters\": {\n \"q\": \"home\",\n \"google_domain\": \"google.com\",\n \"page\": 1,\n \"gl\": \"us\",\n \"hl\": \"en\",\n \"engine\": \"google\"\n },\n \"organic_results\": [\n {\n \"position\": 1,\n \"title\": \"The Home Depot\",\n \"link\": \"https://www.homedepot.com/\",\n \"domain\": \"www.homedepot.com\",\n \"displayed_link\": \"https://www.homedepot.com\",\n \"snippet_matched\": [\n \"home\"\n ],\n \"snippet\": \"Shop online for all your home improvement needs: appliances, bathroom decorating ideas, kitchen remodeling, patio furniture, power tools, bbq grills, ...\"\n },\n {\n \"position\": 2,\n \"title\": \"At Home is The Home & Holiday Superstore\",\n \"link\": \"https://www.athome.com/\",\n \"domain\": \"www.athome.com\",\n \"displayed_link\": \"https://www.athome.com\",\n \"snippet_matched\": [],\n \"snippet\": null\n },\n {\n \"position\": 3,\n \"title\": \"Home (2015)\",\n \"link\": \"https://www.imdb.com/title/tt2224026/\",\n \"domain\": \"www.imdb.com\",\n \"displayed_link\": \"https://www.imdb.com › title\",\n \"snippet_matched\": [],\n \"snippet\": null\n },\n {\n \"position\": 4,\n \"title\": \"Google Home: Smart home automation from Google\",\n \"link\": \"https://home.google.com/welcome/\",\n \"domain\": \"home.google.com\",\n \"displayed_link\": \"https://home.google.com › ...\",\n \"snippet_matched\": [\n \"home\"\n ],\n \"snippet\": \"From smart lights to smart locks, Google Home unites devices and services from Google and your favorite brands to build a personalized smart home to help ...\"\n },\n {\n \"position\": 5,\n \"title\": \"Home Definition & Meaning\",\n \"link\": \"https://www.dictionary.com/browse/home\",\n \"domain\": \"www.dictionary.com\",\n \"displayed_link\": \"https://www.dictionary.com › browse\",\n \"snippet_matched\": [],\n \"snippet\": \"a house, apartment, or other shelter that is the usual residence of a person, family, or household. the place in which one's domestic affections are centered.\"\n },\n {\n \"position\": 6,\n \"title\": \"Home Official Trailer #1 (2015) - YouTube\",\n \"link\": \"https://www.youtube.com/watch?v=MyqZf8LiWvM\",\n \"domain\": \"www.youtube.com\",\n \"displayed_link\": \"https://www.youtube.com › watch\",\n \"snippet_matched\": [],\n \"snippet\": null\n }\n ]\n}","contentType","wysiwyg","language","en","featuredOrder",1,"createdByUser",{"_89":90,"_91":92,"_93":94,"_95":32},"publishedAt",["D",1696599436568],"href","/help/articles/authentication","sectionId","relatedArticles",[],"seoImage",[57,58,59,60,61,62,63,64,65,66,67,68],{"_29":88},{"_87":31,"_76":32},{"_74":86,"_76":30},{"_74":85,"_76":32},{"_74":84,"_76":32},{"_74":82,"_76":83},{"_74":81,"_76":73},{"_74":80,"_76":30},{"_74":79,"_76":32},{"_74":78,"_76":32},{"_74":75,"_76":77},{"_69":70,"_71":72,"_50":73},"tagName","link","rel","canonical","https://app.autom.dev/help/articles/authentication","property","twitter:card","content","summary_large_image","twitter:image","twitter:description","twitter:title","og:url","og:type","article","og:image","og:description","og:title","name","Authentication | Help","email","josselin.liebe@piloterr.com","firstName","Josselind","lastName","Liebe","avatar",{"_21":97,"_27":98,"_33":45,"_29":99,"_31":32,"_100":32,"_42":43,"_55":32,"_50":101,"_102":103,"_104":105,"_9":106},"cllpo450s002po97u29ojyiyo","api","API","icon","/help/categories/api","sections",[],"articles",[122,123,124],[107,108,109,110,111,112,113,114,115,116,117,118],{"_29":120},{"_87":31,"_76":32},{"_74":86,"_76":120},{"_74":85,"_76":32},{"_74":84,"_76":32},{"_74":82,"_76":121},{"_74":81,"_76":119},{"_74":80,"_76":120},{"_74":79,"_76":32},{"_74":78,"_76":32},{"_74":75,"_76":77},{"_69":70,"_71":72,"_50":119},"https://app.autom.dev/help/categories/api","API | Help","website",{"_21":133,"_33":45,"_29":134,"_31":32,"_42":43,"_27":135,"_50":136,"_52":-5,"_48":137,"_131":133},{"_21":22,"_33":34,"_29":30,"_31":32,"_42":43,"_27":28,"_50":51,"_52":-5,"_48":132,"_131":22},{"_21":125,"_33":126,"_29":127,"_31":32,"_42":43,"_27":128,"_50":129,"_52":-5,"_48":130,"_131":125},"cllrudq2k0080ol7vim1mwas5",3,"Usage","usage","/help/articles/usage",["D",1693043599805],"categoryId",["D",1696599436568],"cllpo2ubn002bo97u6799xc9h","Status Code","status-code","/help/articles/status-code",["D",1692973504706],"cllpddnzq001xvu3o42zyg70z","2023-08-24T16:20:02.103Z","2023-09-07T20:52:09.956Z","basePath","/","help","Help","Documentation API about autom.dev","defaultLanguage","layout","languages",[43],"links",[161,162],"color","enabled",true,"count",{"_104":126,"_14":45,"_159":160},"logo","dark","views",174,{"_87":165,"_50":166,"_33":45},{"_87":163,"_50":164,"_33":34},"Website","https://www.autom.dev/","Dashboard","/app",{"_29":144},{"_87":31,"_76":145},{"_74":86,"_76":144},{"_74":85,"_76":145},{"_74":84,"_76":32},{"_74":82,"_76":121},{"_74":81,"_76":179},{"_74":80,"_76":144},{"_74":79,"_76":145},{"_74":78,"_76":32},{"_74":75,"_76":77},{"_69":70,"_71":72,"_50":179},"https://app.autom.dev/help",[351,352,353,354,355,356,357,358],"user","currentTenant","locale","theme","zinc-scaled","serverUrl","https://app.autom.dev","apiOrigin","https://api.autom.dev","domainName","app.autom.dev","userSession",{"_236":-5,"_346":32,"_347":43,"_268":348,"_263":349},"authenticated","debug","isStripeTest","appConfiguration",{"_255":256,"_89":257,"_258":259,"_201":260,"_261":262,"_263":264,"_265":266,"_203":267,"_268":269,"_270":271,"_272":273},"csrf","IihmM8Gd6rm5CR7+y7J+09931LMeuZRc+dSeW7KhDgQZuzgkpye5n2xIk9xF/i5/ewI9aEICaWKTcZWT4vZ3Uf8CFuQem55aa4ugyWWKcA6D3gm8qGj+wCFCsSm7b7pDCbBr9w==","analytics",{"_230":231,"_232":233,"_234":235,"_236":-5,"_237":238},"featureFlags",[],"impersonatingSession","brandAssets",{"_210":211,"_212":213,"_214":215,"_216":217,"_218":219,"_220":221,"_222":223,"_224":225,"_226":227,"_228":229},"appVersion","5.20.194","favicon","/brand-assets/autom/favicon.ico","favicon16","/brand-assets/autom/favicon-16x16.png","favicon32","/brand-assets/autom/favicon-32x32.png","favicon96","/brand-assets/autom/favicon-96x96.png","appleTouchIcon","/brand-assets/autom/apple-touch-icon.png","androidChrome192","/brand-assets/autom/android-chrome-192x192.png","androidChrome512","/brand-assets/autom/android-chrome-512x512.png","socialThumbnail","/brand-assets/autom/thumbnail.png","manifest","/brand-assets/autom/manifest.json","browserconfig","/brand-assets/autom/browserconfig.xml","ip","216.73.216.175","userAgent",{"_244":245,"_246":247,"_248":249},"referrer",{"_243":32},"userId","region",{"_239":240,"_241":242},"country","US","city","Columbus","source","type","desktop","os",{"_253":254,"_251":-5},"browser",{"_87":250,"_251":252},"Node.js","version","25.9.0","family","Linux","app",{"_87":335,"_336":187,"_337":191,"_184":185,"_338":339},{"_325":326,"_327":328,"_329":330,"_331":328,"_332":333,"_334":330},"auth",{"_293":154,"_294":154,"_295":19,"_27":296,"_297":298,"_299":300,"_301":302},{"_153":154,"_290":291,"_292":154},"subscription",{"_284":154,"_285":19,"_286":154,"_287":19,"_288":19,"_289":154},"cookies",{"_153":19},"notifications",{"_153":154},{"_153":19},"metrics",{"_153":19,"_278":19,"_279":19,"_280":281},"branding",{"_157":276,"_100":277},"scripts",{"_274":-5,"_275":-5},"head","body","/brand-assets/autom/logo.svg","/brand-assets/autom/icon.png","logToConsole","saveToDatabase","ignoreUrls",[282,283],"/admin/metrics","/build","required","allowSubscribeBeforeSignUp","allowSignUpBeforeSubscribe","multiple","creditsRequirePaidPlan","autoTopUpEnabled","googleAnalyticsTrackingId","GTM-P87WG2JM","ipLookup","requireEmailVerification","requireOrganization","requireAccountApproval",{"_323":19,"_244":324},"veilleChallenge",{"_153":154,"_319":320,"_321":322},"authMethods",{"_311":312,"_313":314,"_315":316},"veille",{"_153":154,"_303":154,"_304":19,"_305":154,"_306":154,"_307":308},"blockDisposable","blockPublicDomain","blockEducation","blockCatchall","riskScore",{"_153":154,"_309":310},"threshold",30,"emailPassword",{"_153":154},"github",{"_153":154,"_317":318},"google",{"_153":154},"authorizationURL","https://app.autom.dev/oauth/github","apiUrl","https://challenge.veille.io","siteKey","a3826a57e2","require","username","provider","postmark","fromEmail","contact@autom.dev","fromName","Autom","supportEmail","marketingEmail","josselin@autom.dev","marketingName","autom","url","domain","features",{"_340":341,"_342":154,"_343":154,"_344":154,"_345":154},"tenantHome","/app/:tenant/","tenantApiKeys","tenantEntityCustomization","tenantTypes","surveys","lightOrDarkMode","lng",{"_153":19,"_278":19,"_279":19,"_280":350},[],[],{"_29":330},{"_74":86,"_76":330},{"_74":82,"_76":121},{"_74":84,"_76":359},{"_74":81,"_76":187},{"_87":75,"_76":77},{"_87":80,"_76":330},{"_87":78,"_76":359},"https://app.autom.dev/brand-assets/autom/thumbnail.png"]

Featured articles

API