Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.
This section walks you from zero to your first personalized offer. It takes about 30 minutes if you already have a game server that can make HTTPS calls.There are three pages:
Quickstart — sign up, create a game, get an API key, send your first event.
SDK & Integration — the three endpoints you’ll actually use (events, offers, recommendations), with working curl examples.
You don’t need to install anything. Qyren is a REST API. If your game server can POST JSON, you can integrate in an afternoon.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Qyren","colors":{"primary":"#D4AF37","light":"#F5E27A","dark":"#B8962E"},"logo":{"light":"https://mintcdn.com/qyren/wJpe1Abyp32ypJga/logo-light.png?fit=max\u0026auto=format\u0026n=wJpe1Abyp32ypJga\u0026q=85\u0026s=f9ebddcea78f9524cadd1cfa17dfc210","dark":"https://mintcdn.com/qyren/wJpe1Abyp32ypJga/logo-dark.png?fit=max\u0026auto=format\u0026n=wJpe1Abyp32ypJga\u0026q=85\u0026s=2ca6b110db48d48ef4ca1a531900767e"},"favicon":"https://mintcdn.com/qyren/Va-csEtC9MCfc5Uw/favicon.png?fit=max\u0026auto=format\u0026n=Va-csEtC9MCfc5Uw\u0026q=85\u0026s=25de6796971a238a900bd7fa9d5e7950","styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"App Login","icon":"grid","href":"https://app.qyren.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qyren","hasAudioNarration":false,"actualSubdomain":"qyren","customDomains":["docs.qyren.ai"],"gitSource":{"type":"github","owner":"rknlabs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21dcec7005524106c9d017","collectionId":"66b1a903-24dd-4452-8afc-b461ed03602d","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21dcec7005524106c9d017:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Docs","count":36},{"language":"default","tag":"Integration","count":7},{"language":"default","tag":"API Reference","count":6},{"language":"default","tag":"Economy Health","count":5},{"language":"default","tag":"Recommendations","count":5},{"language":"default","tag":"Billing","count":4},{"language":"default","tag":"Core Concepts","count":4},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Glossary","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"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":"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":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","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":"fork-pr-previews","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","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},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"getting-started/README","slug":"/getting-started/README","pageMetadata":{"title":"Overview","description":"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.","href":"/getting-started/README"},"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: \"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\"\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`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This section walks you from zero to your first personalized offer. It takes about 30 minutes if you already have a game server that can make HTTPS calls.`}),`\n`,_jsx(_components.p,{children:`There are three pages:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/getting-started/quickstart`,children:`Quickstart`}),` — sign up, create a game, get an API key, send your first event.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/getting-started/sdk-integration`,children:`SDK \u0026 Integration`}),` — the three endpoints you’ll actually use (events, offers, recommendations), with working curl examples.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`You don’t need to install anything. Qyren is a REST API. If your game server can `,_jsx(_components.code,{children:`POST`}),` JSON, you can integrate in an afternoon.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Overview","description":"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.","href":"/getting-started/README"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"qyren","siteName":"Qyren","title":"Overview - Qyren","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-13T10:54:30.450Z","originalFileLocation":"getting-started/README.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Qyren\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_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/qyren/Cd8eBncNCXMw9buD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Qyren\">\u003cmeta data-mint-head property=\"og:description\" content=\"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qyren\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qyren.ai/getting-started/README\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qyren.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Overview\u0026amp;description=Walks+you+from+zero+to+your+first+personalized+offer+in+about+30+minutes%2C+using+only+REST+calls.\u0026amp;theme=48aa5d3669540682cb98bfb1\u0026amp;signature=778667c6af215ad14ce00227a3b75439b80508e0b770d34ce1993cf0d2c9ed70\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Overview - Qyren\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qyren.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Overview\u0026amp;description=Walks+you+from+zero+to+your+first+personalized+offer+in+about+30+minutes%2C+using+only+REST+calls.\u0026amp;theme=48aa5d3669540682cb98bfb1\u0026amp;signature=778667c6af215ad14ce00227a3b75439b80508e0b770d34ce1993cf0d2c9ed70\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/qyren/Cd8eBncNCXMw9buD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qyren\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D4AF37\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qyren.ai/getting-started/README\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/README.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qyren.ai/#organization\",\"name\":\"Qyren\",\"url\":\"https://docs.qyren.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qyren/wJpe1Abyp32ypJga/logo-light.png?fit=max\u0026auto=format\u0026n=wJpe1Abyp32ypJga\u0026q=85\u0026s=f9ebddcea78f9524cadd1cfa17dfc210\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qyren.ai#website\",\"name\":\"Qyren\",\"url\":\"https://docs.qyren.ai\",\"publisher\":{\"@id\":\"https://docs.qyren.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qyren.ai/getting-started/README#webpage\",\"url\":\"https://docs.qyren.ai/getting-started/README\",\"name\":\"Overview\",\"description\":\"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\",\"dateModified\":\"2026-04-13T10:54:30.450Z\",\"isPartOf\":{\"@id\":\"https://docs.qyren.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qyren.ai/getting-started/README#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qyren.ai/getting-started/README#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.qyren.ai/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.qyren.ai/getting-started/README\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.qyren.ai/getting-started/README#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Walks you from zero to your first personalized offer in about 30 minutes, using only REST calls.\",\"url\":\"https://docs.qyren.ai/getting-started/README\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qyren.ai/getting-started/README#webpage\"},\"dateModified\":\"2026-04-13T10:54:30.450Z\",\"publisher\":{\"@id\":\"https://docs.qyren.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qyren.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qyren\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Qyren","nav":{"global":{"anchors":[{"anchor":"App Login","icon":"grid","href":"https://app.qyren.ai"}]},"tabs":[{"tab":"Docs","groups":[{"group":"Getting Started","pages":[{"title":"Qyren Documentation","description":"Monetization intelligence for free-to-play games","href":""},{"title":"Overview","href":"/getting-started/README"},{"title":"Quickstart","description":"Sign up, create a game, generate an API key, and send your first event to Qyren.","href":"/getting-started/quickstart"},{"title":"SDK and Integration","href":"/getting-started/sdk-integration"}]},{"group":"Core Concepts","pages":[{"title":"Overview","href":"/core-concepts/README"},{"title":"Faucets and Sinks","href":"/core-concepts/faucets-and-sinks"},{"title":"Player Segments","href":"/core-concepts/player-segments"},{"title":"Monetization Basics","href":"/core-concepts/monetization-basics"}]},{"group":"Economy Health","pages":[{"title":"Overview","href":"/economy-health/README"},{"title":"Health Score","href":"/economy-health/health-score"},{"title":"Sink-to-Source Ratio","href":"/economy-health/sink-to-source-ratio"},{"title":"Inflation Rate","href":"/economy-health/inflation-rate"},{"title":"Alerts","href":"/economy-health/alerts"}]},{"group":"Recommendations","pages":[{"title":"Overview","href":"/recommendations/README"},{"title":"How Offer Recommendations Work","href":"/recommendations/how-it-works"},{"title":"Retention Drop Recommendations","href":"/recommendations/retention-drop"},{"title":"Monetization Underperformance Recommendations","href":"/recommendations/monetization-underperformance"},{"title":"Economy Inflation Recommendations","href":"/recommendations/economy-inflation"}]},{"group":"Billing","pages":[{"title":"Overview","href":"/billing/README"},{"title":"Plans","href":"/billing/plans"},{"title":"Lift Calculation","href":"/billing/lift-calculation"},{"title":"Reading Your Invoice","href":"/billing/reading-your-invoice"}]},{"group":"Integration","pages":[{"title":"Overview","href":"/integration/README"},{"title":"REST API Integration","href":"/integration/rest-api"},{"title":"Event Schema","href":"/integration/event-schema"},{"title":"Offer Import","href":"/integration/offer-import"},{"title":"Testing Your Integration","href":"/integration/testing"},{"title":"Unity SDK","href":"/integration/unity"},{"title":"Unreal SDK","href":"/integration/unreal"}]},{"group":"API Reference","pages":[{"title":"Overview","href":"/api-reference/README"},{"title":"Events API","href":"/api-reference/events"},{"title":"Offers API","href":"/api-reference/offers"},{"title":"Recommendations API","href":"/api-reference/recommendations"},{"title":"Economy API","href":"/api-reference/economy"},{"title":"Billing API","href":"/api-reference/billing"}]},{"group":"Glossary","pages":[{"title":"Glossary","href":"/glossary"}]}]}]},"title":"Overview - Qyren","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}