documentation/guides/sdks/getting-started.md
:::scalar-callout{ type=info } SDK generation is part of our paid plans and costs $100 per month per language. Keep this in mind when selecting which languages you'd like to generate SDKs for. :::
Make sure you have created a Scalar Account & are logged in (see create account guide)
From the dashboard click "Create new SDK".
If you don't already have an OpenAPI document on our registry, you can import it right in the modal.
</scalar-step> <scalar-step id="step-2" title="Select Desired Languages"> Select as many SDKs as you would like, or just one language to start. Once you click "Continue" we will begin generating your SDKs. </scalar-step> <scalar-step id="step-3" title="Manage your new SDKs"> Once created, you will get redirected to the SDK Overview page where you can: - Configure your SDK settings - Add our GitHub Integration - Downlad the SDK Client </scalar-step> </scalar-steps><scalar-image src="/sdk-dashboard-static.svg" src-dark="/sdk-dashboard-static-dark.svg"></scalar-image>
<div class="feature"> <h2>Features</h2> <div class="flex flex-wrap feature-container"> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/arrow-up-right"></scalar-icon> OpenAPI-First </b> </div> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/brackets-square"></scalar-icon> Custom-code </b> </div> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/code"></scalar-icon> Code Samples </b> </div> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/fingerprint"></scalar-icon> OpenAPI Authentication </b> </div> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/cloud-check"></scalar-icon> Syncs with Docs </b> </div> <div class="feature-item"> <b class="flex items-center icon-text gap-3 font-medium min-h-8 text-purple"> <scalar-icon src="phosphor/bold/file-cloud"></scalar-icon> File Streaming Support </b> </div> </div> <div class="cta flex flex-col gap-3 small-test"> <scalar-heading level="2" class="text-balance" slug="what-are-you-waiting-for">What are you waiting for?</scalar-heading> <p> We're committed to enabling developers and companies to practice the highest of API industry standards. </p> <div class="flex gap-2 mb-11"> <a class="t-editor__button" href="https://dashboard.scalar.com/register">Get Started</a> <a class="t-editor__button" href="https://scalar.cal.com/scalar/chat-with-scalar" target="_blank">Book a Demo</a> </div> <a class="expander-hover-link" href="https://discord.gg/scalar" target="_blank" aria-label="Join Scalar community on Discord">Community →</a> <a class="expander-hover-link" href="https://github.com/scalar/scalar" target="_blank" aria-label="View Scalar on GitHub">GitHub →</a> <a class="expander-hover-link" href="mailto:[email protected]" target="_blank" aria-label="Contact Scalar support">Contact Us →</a> </div> </div> </div> <div class="resources-cta sticky"> <div class="resources-cta-container"> <p class="mt-3 mb-1 pl-2"> <b class="font-medium">Additional Reading</b> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/sdks/configuration/typescript"><scalar-icon src="phosphor/bold/file-ts"></scalar-icon> Typescript SDKs</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/sdks/publishing"><scalar-icon src="phosphor/bold/package"></scalar-icon> Publishing to npm</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/registry/getting-started"><scalar-icon src="phosphor/bold/seal-check"></scalar-icon> Registry</a> </p> <p class="mt-3 mb-1 pl-2"> <b class="font-medium">Community</b> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://discord.gg/scalar" target="_blank"><scalar-icon src="phosphor/bold/discord-logo"></scalar-icon> Discord</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://twitter.com/scalar" target="_blank"><scalar-icon src="phosphor/bold/twitter-logo"></scalar-icon> Twitter</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://github.com/scalar/scalar" target="_blank"><scalar-icon src="phosphor/bold/github-logo"></scalar-icon> GitHub</a> </p> </div> </div> </div> <div class="expander-container"> <div class="expander-hover"> <div class="expander-hover-preview"></div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-client" width="156" height="110"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/JXS6tZ4EbKIkeGpjP6QKc.svg"></object>
</div>
<div class="expander-hover-title">API Client</div>
<div class="expander">
<div class="expander-content">
Minimal, powerful, fully open-source API Client built on open standards by us + our community.
</div>
</div>
<a class="expander-hover-link" href="https://client.scalar.com/" target="_blank" aria-label="Learn more about API Client">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-sdk" width="145" height="145"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/gM-mqYTBYMkqpnexTIr-r.svg"></object>
</div>
<div class="expander-hover-title">SDKs</div>
<div class="expander">
<div class="expander-content">
Bring your OpenAPI document and get type-safe client libraries for TypeScript, Python and more.
</div>
</div>
<a class="expander-hover-link" href="/products/sdks/getting-started" aria-label="Learn more about SDKs">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-registry" width="136" height="186"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/jgGF_IKsu-T_irS-6MMOy.svg"></object>
</div>
<div class="expander-hover-title">API Registry</div>
<div class="expander">
<div class="expander-content">
Managing & versioning OpenAPI Documents with a deep Git integration.
</div>
</div>
<a class="expander-hover-link" href="/products/registry/getting-started" aria-label="Learn more about API Registry">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-docs" width="113" height="143" data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/HLhbFqJ4vSzo4UDEZX2dq.svg"></object>
</div>
<div class="expander-hover-title">API Docs</div>
<div class="expander">
<div class="expander-content">
Write beautiful documentation with Markdown + MDX + Git Sync.
</div>
</div>
<a class="expander-hover-link" href="/products/docs/getting-started" aria-label="Learn more about API Docs">Learn More</a>
</div>