{"id":5041,"date":"2026-02-24T11:59:07","date_gmt":"2026-02-24T11:59:07","guid":{"rendered":"https:\/\/www.arivonix.ai\/techsupport\/docs\/creating-an-api\/"},"modified":"2026-02-27T06:05:20","modified_gmt":"2026-02-27T06:05:20","password":"","slug":"creating-an-api","status":"publish","type":"docs","link":"https:\/\/www.arivonix.ai\/documentation\/docs\/creating-an-api\/","title":{"rendered":"Creating an API"},"content":{"rendered":"<section class=\"documentation-content\">\n<h1><a href=\"creating-api\" class=\"titleAnchor\"><\/a>Creating an API<\/h1>\n<p>Create and configure APIs to enable secure data access and querying capabilities in Arivonix.<\/p>\n<ol>\n<li>From the <strong>Data Access API<\/strong> card, locate the <strong>Action Menu<\/strong> in the right corner. <img decoding=\"async\" src=\"\/documentation\/tech-image\/Tech\/Creating_an_API\/image_5.76.png\/\" alt=\"Relevant visual\" class=\"img-fluid img-screenshot\" \/> Select <strong>API Collections<\/strong>.<\/li>\n<li>Click the <strong>Create API<\/strong> button to begin configuration. <img decoding=\"async\" src=\"\/documentation\/tech-image\/Tech\/Creating_an_API\/image_11.80.png\/\" alt=\"Relevant visual\" class=\"img-fluid img-screenshot\" \/><\/li>\n<li>Configure the API by entering the following required details:\n<ul>\n<li><strong>API Endpoint<\/strong><\/li>\n<li><strong>Module<\/strong><\/li>\n<li><strong>Protocol<\/strong><\/li>\n<li><strong>Tags<\/strong><\/li>\n<\/ul>\n<\/li>\n<li>For the SQL configuration:\n<ul>\n<li>Either generate SQL using a custom prompt, or<\/li>\n<li>Directly input the SQL query<\/li>\n<\/ul>\n<\/li>\n<li>Test the SQL implementation:\n<ul>\n<li>Click the <strong>Run SQL<\/strong> button to execute<\/li>\n<li>Review the preview results<\/li>\n<li>Examine the output structure<\/li>\n<\/ul>\n<\/li>\n<li>Configure the output:\n<ul>\n<li>Generate using a custom prompt, or<\/li>\n<li>Enter SQL query directly<\/li>\n<li>Review the output preview at the bottom of the section<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong>Save<\/strong> to complete the API creation. <img decoding=\"async\" src=\"\/documentation\/tech-image\/Tech\/Creating_an_API\/image_54.43.png\/\" alt=\"Relevant visual\" class=\"img-fluid img-screenshot\" \/><\/li>\n<\/ol>\n<\/section>\n","protected":false},"excerpt":{"rendered":"<p>Creating an API Create and configure APIs to enable secure data access and querying capabilities in Arivonix. From the Data Access API card, locate the Action Menu in the right corner. Select API Collections. Click the Create API button to begin configuration. Configure the API by entering the following required details: API Endpoint Module Protocol [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[167],"doc_tag":[],"class_list":["post-5041","docs","type-docs","status-publish","hentry","doc_category-data-access-api"],"year_month":"2026-04","word_count":109,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"Hari","author_nicename":"hari","author_url":""},"doc_category_info":[{"term_name":"Data Access API","term_url":"https:\/\/www.arivonix.ai\/documentation\/docs-category\/data-access-api\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/docs\/5041","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/comments?post=5041"}],"version-history":[{"count":1,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/docs\/5041\/revisions"}],"predecessor-version":[{"id":5229,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/docs\/5041\/revisions\/5229"}],"wp:attachment":[{"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/media?parent=5041"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/doc_category?post=5041"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.arivonix.ai\/documentation\/wp-json\/wp\/v2\/doc_tag?post=5041"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}