The RESTful protocol is the default protocol that is active when you open Auk. Auk allows you to make API requests and examine the responses.You can enter the API endpoint and choose the HTTP method according to your needs from the dropdown menu.
Once it is configured, click on the “Send” button and you will see the response returned by the server. It’s that simple.Now try it yourself. Copy the below API endpoint and create a request.
https://httpbin.org/get
Let’s try another API.We’ll be using the Pokemon API. Go ahead and create a GET request to the endpoint below:
https://pokeapi.co/api/v2
If your request was successful, then you should get a JSON response as shown below:
The Pokemon API has returned several new API endpoints or URLs, let’s pick the character’s URL and explore it.To explore the characters create a GET request to the URL https://pokeapi.co/api/v2/pokemon by copy-pasting the URL below:
https://pokeapi.co/api/v2/pokemon
The API should have returned a huge amount of data, something similar to the one below:
Try experimenting with the /pokedex, /berry, and the other endpoints as well.
RESTful protocol
Learn more about RESTful protocol.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Auk Documentation","description":"Local-first API development tool","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/postdata/lhXQFwU8KaF9-ZVG/logo/light.svg?fit=max\u0026auto=format\u0026n=lhXQFwU8KaF9-ZVG\u0026q=85\u0026s=c5e2baefafed89eebb2b8a03ce501dd0","dark":"https://mintcdn.com/postdata/lhXQFwU8KaF9-ZVG/logo/dark.svg?fit=max\u0026auto=format\u0026n=lhXQFwU8KaF9-ZVG\u0026q=85\u0026s=3320f44c8e595dcf7e0525be87a9e0b8"},"favicon":"/favicon.svg","navbar":{"primary":{"type":"github","href":"https://github.com/mamahuhu-io/auk"}},"footer":{"socials":{"github":"https://github.com/mamahuhu-io/auk","website":"https://auk.mamahuhu.io"}},"search":{"prompt":"Search Auk Documentation"},"styling":{"eyebrows":"breadcrumbs","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"postdata","hasAudioNarration":false,"actualSubdomain":"postdata","customDomains":["auk.mamahuhu.dev"],"gitSource":{"type":"github","owner":"mamahuhu-io","repo":"auk-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21f61eeb6d34542d2765be","collectionId":"b5c88f87-c4d9-4336-8a8e-e2ceef899161","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{},"buildId":"6a21f61eeb6d34542d2765be:success","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Documentation","count":58},{"language":"default","tag":"API Testing","count":19},{"language":"default","tag":"Features","count":14},{"language":"default","tag":"RESTful API","count":10},{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"Support","count":6},{"language":"default","tag":"Git Sync","count":6},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Resources","count":4},{"language":"default","tag":"Core Concepts","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"documentation/getting-started/rest/creating-a-request","slug":"/documentation/getting-started/rest/creating-a-request","pageMetadata":{"sidebarTitle":"Creating a request","title":"Creating a request","description":"Learn how to create a request in Auk.","href":"/documentation/getting-started/rest/creating-a-request","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn how to create a request in Auk.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Card,CodeBlock}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The RESTful protocol is the default protocol that is active when you open Auk. Auk allows you to make API requests and examine the responses.`}),`\n`,_jsxs(_components.p,{children:[`You can enter the API endpoint and choose the HTTP method according to your needs from the dropdown menu.\nOnce it is configured, click on the “`,_jsx(_components.strong,{children:`Send`}),`” button and you will see the response returned by the server. It’s that simple.`]}),`\n`,_jsx(_components.p,{children:`Now try it yourself. Copy the below API endpoint and create a request.`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://httpbin.org/get`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Let’s try another API.`}),`\n`,_jsxs(_components.p,{children:[`We’ll be using the `,_jsx(_components.a,{href:`https://github.com/PokeAPI/pokeapi`,children:`Pokemon API`}),`. Go ahead and create a `,_jsx(_components.code,{children:`GET`}),` request to the endpoint below:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://pokeapi.co/api/v2`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`If your request was successful, then you should get a JSON response as shown below:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ability\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/ability/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"berry\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/berry/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pokedex\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/pokedex/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pokemon\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/pokemon/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version-group\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/version-group/\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The Pokemon API has returned several new API endpoints or URLs, let’s pick the character’s URL and explore it.`}),`\n`,_jsxs(_components.p,{children:[`To explore the characters create a `,_jsx(_components.code,{children:`GET`}),` request to the URL `,_jsx(_components.code,{children:`https://pokeapi.co/api/v2/pokemon`}),` by copy-pasting the URL below:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://pokeapi.co/api/v2/pokemon`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`The API should have returned a huge amount of data, something similar to the one below:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1279`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"next\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/pokemon?offset=20\u0026limit=20\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"previous\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"results\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bulbasaur\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/pokemon/1/\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ivysaur\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pokeapi.co/api/v2/pokemon/2/\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Try experimenting with the `,_jsx(_components.code,{children:`/pokedex`}),`, `,_jsx(_components.code,{children:`/berry`}),`, and the other endpoints as well.`]}),`\n`,_jsx(Card,{title:`RESTful protocol`,iconType:`light`,icon:`circle-arrow-right`,href:`/documentation/protocols/rest`,children:_jsx(_components.p,{children:`Learn more about RESTful protocol.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"sidebarTitle":"Creating a request","title":"Creating a request","description":"Learn how to create a request in Auk.","href":"/documentation/getting-started/rest/creating-a-request","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"postdata","siteName":"Auk Documentation","title":"Creating a request - Auk Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-27T06:02:51.141Z","originalFileLocation":"documentation/getting-started/rest/creating-a-request.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Learn how to create a request in Auk.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Auk Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Creating a request - Auk Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to create a request in Auk.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Auk Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Creating a request - Auk Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to create a request in Auk.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/postdata/g4faQXK6JiIFoACF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Auk Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/documentation/getting-started/rest/creating-a-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://auk.mamahuhu.dev/#organization\",\"name\":\"Auk Documentation\",\"url\":\"https://auk.mamahuhu.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/postdata/lhXQFwU8KaF9-ZVG/logo/light.svg?fit=max\u0026auto=format\u0026n=lhXQFwU8KaF9-ZVG\u0026q=85\u0026s=c5e2baefafed89eebb2b8a03ce501dd0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://auk.mamahuhu.dev#website\",\"name\":\"Auk Documentation\",\"url\":\"https://auk.mamahuhu.dev\",\"publisher\":{\"@id\":\"https://auk.mamahuhu.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request#webpage\",\"url\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request\",\"name\":\"Creating a request\",\"description\":\"Learn how to create a request in Auk.\",\"dateModified\":\"2026-02-27T06:02:51.141Z\",\"isPartOf\":{\"@id\":\"https://auk.mamahuhu.dev#website\"},\"breadcrumb\":{\"@id\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Testing\",\"item\":\"https://auk.mamahuhu.dev/documentation/protocols/rest\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Creating a request\",\"item\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request#article\",\"headline\":\"Creating a request\",\"name\":\"Creating a request\",\"description\":\"Learn how to create a request in Auk.\",\"url\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request\",\"mainEntityOfPage\":{\"@id\":\"https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request#webpage\"},\"dateModified\":\"2026-02-27T06:02:51.141Z\",\"publisher\":{\"@id\":\"https://auk.mamahuhu.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://auk.mamahuhu.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Auk Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Auk Documentation","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book","groups":[{"group":"Getting Started","pages":[{"sidebarTitle":"Introduction","title":"Introduction to Auk","href":"/documentation/getting-started/introduction"},{"sidebarTitle":"Installation","title":"Install Auk","href":"/documentation/getting-started/installation"},{"sidebarTitle":"First Workspace","title":"Create Your First Workspace","href":"/documentation/getting-started/first-workspace"},{"sidebarTitle":"Git Setup","title":"Setup Git Sync","href":"/documentation/getting-started/git-setup"},{"sidebarTitle":"Quick Start","title":"Quick Start Guide","href":"/documentation/getting-started/quick-start"}]},{"group":"Core Concepts","pages":[{"sidebarTitle":"Local First","title":"Local-First Architecture","href":"/documentation/concepts/local-first"},{"title":"Workspaces","href":"/documentation/concepts/workspaces"},{"title":"Git Sync","href":"/documentation/concepts/git-sync"},{"title":"Data Storage","href":"/documentation/concepts/data-storage"}]},{"group":"Workspace Management","pages":[{"sidebarTitle":"Workspace Introduction","title":"Workspace Management","href":"/documentation/workspace/introduction"},{"title":"Creating a Workspace","href":"/documentation/workspace/creating"},{"title":"Switching Workspaces","href":"/documentation/workspace/switching"},{"title":"Workspace Settings","href":"/documentation/workspace/settings"}]},{"group":"Git Sync","pages":[{"sidebarTitle":"Git Sync Introduction","title":"Git Sync Overview","href":"/documentation/git-sync/introduction"},{"title":"Git Sync Setup","href":"/documentation/git-sync/setup"},{"title":"Authentication","href":"/documentation/git-sync/authentication"},{"title":"Auto Sync","href":"/documentation/git-sync/auto-sync"},{"title":"Conflict Resolution","href":"/documentation/git-sync/conflict-resolution"},{"title":"Git Sync Troubleshooting","href":"/documentation/git-sync/troubleshooting"}]},{"group":"API Testing","pages":[{"sidebarTitle":"RESTful","title":"RESTful","href":"/documentation/protocols/rest"},{"sidebarTitle":"GraphQL","title":"GraphQL","href":"/documentation/protocols/graphql"},{"sidebarTitle":"Realtime","title":"Realtime","description":"Auk's Realtime API platform helps you test your real-time APIs easily.","href":"/documentation/protocols/realtime"},{"group":"RESTful API","pages":[{"sidebarTitle":"Creating a request","title":"Creating a request","href":"/documentation/getting-started/rest/creating-a-request"},{"sidebarTitle":"Response handling","title":"Response handling","description":"View, interpret and manage responses from your API requests.","href":"/documentation/getting-started/rest/response-handling"},{"sidebarTitle":"Request parameters","title":"Request parameters","href":"/documentation/getting-started/rest/request-parameters"},{"sidebarTitle":"Request headers","title":"Request headers","href":"/documentation/getting-started/rest/request-headers"},{"sidebarTitle":"Organizing requests","title":"Organizing requests","href":"/documentation/getting-started/rest/organizing-requests"},{"sidebarTitle":"Environment variables","title":"Environment variables","href":"/documentation/getting-started/rest/environment-variables"},{"sidebarTitle":"Using auth tokens","title":"Using auth tokens","href":"/documentation/getting-started/rest/auth-tokens"},{"sidebarTitle":"Uploading data","title":"Uploading data","href":"/documentation/getting-started/rest/uploading-data"},{"sidebarTitle":"Pre-request scripts","title":"Pre-request scripts","href":"/documentation/getting-started/rest/pre-request-scripts"},{"sidebarTitle":"Tests","title":"Tests","href":"/documentation/getting-started/rest/tests"}]},{"group":"GraphQL API","pages":[{"sidebarTitle":"Running a simple query","title":"Running a simple query","href":"/documentation/getting-started/graphql/creating-a-query"},{"sidebarTitle":"Using variables","title":"Using variables in a GraphQL query","href":"/documentation/getting-started/graphql/using-variables"}]},{"group":"Realtime API","pages":[{"sidebarTitle":"Websocket","title":"Websocket","href":"/documentation/getting-started/realtime/websocket"},{"sidebarTitle":"Socket.IO","title":"Socket.IO","href":"/documentation/getting-started/realtime/socket-io"},{"sidebarTitle":"SSE","title":"Server-Sent Events","href":"/documentation/getting-started/realtime/sse"},{"sidebarTitle":"MQTT","title":"MQTT","href":"/documentation/getting-started/realtime/mqtt"}]}]},{"group":"Features","pages":[{"sidebarTitle":"Collections","title":"Collections","href":"/documentation/features/collections"},{"sidebarTitle":"Environments","title":"Environments","href":"/documentation/features/environments"},{"sidebarTitle":"Variables","title":"Variables","href":"/documentation/features/variables"},{"sidebarTitle":"History","title":"History","href":"/documentation/features/history"},{"sidebarTitle":"Scripts","title":"Scripts","href":"/documentation/features/scripts"},{"sidebarTitle":"Runner","title":"Runner","href":"/documentation/features/runner"},{"sidebarTitle":"Importer","title":"Importer","href":"/documentation/features/importer"},{"sidebarTitle":"Authorization","title":"Authorization","href":"/documentation/features/authorization"},{"sidebarTitle":"Shortcuts","title":"Shortcuts","href":"/documentation/features/shortcuts"},{"sidebarTitle":"Customization","title":"Customization","href":"/documentation/features/customization"},{"sidebarTitle":"Code Snippets","title":"Code Snippets","href":"/documentation/features/snippets"},{"sidebarTitle":"Interceptor","title":"Interceptor","href":"/documentation/features/interceptor"},{"sidebarTitle":"Cookies","title":"Cookies","href":"/documentation/features/cookies"},{"sidebarTitle":"Client Certificate","title":"Client Certificate","href":"/documentation/features/client-certificate"}]},{"group":"Data Management","pages":[{"title":"File System Storage","href":"/documentation/storage/file-system"},{"title":"Data Location","href":"/documentation/storage/data-location"},{"title":"Backup \u0026 Restore","href":"/documentation/storage/backup-restore"}]},{"group":"Desktop Client","pages":[{"sidebarTitle":"Desktop","title":"Auk Desktop App","href":"/documentation/clients/desktop"},{"group":"CLI","pages":[{"sidebarTitle":"Overview","title":"Auk CLI","href":"/documentation/clients/cli/overview"},{"sidebarTitle":"Troubleshooting","title":"Auk CLI Troubleshooting","href":"/documentation/clients/cli/troubleshooting"}]}]}]},{"anchor":"Guides","icon":"lightbulb","pages":[{"title":"Guides","href":"/guides/local-first-workflow"}]},{"anchor":"Support","icon":"question","pages":[{"title":"Support","href":"/support/getting-started/faq"}]},{"anchor":"Download","icon":"download","href":"https://auk.mamahuhu.io/download"},{"anchor":"GitHub","icon":"github","href":"https://github.com/mamahuhu-io/auk"}]},"title":"Creating a request - Auk Documentation","buildId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","deploymentId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","dynamics":[],"chunks":[]}