Microsoft.OpenApi.Kiota 1.6.1

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
.NET 7.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global Microsoft.OpenApi.Kiota --version 1.6.1
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Microsoft.OpenApi.Kiota --version 1.6.1
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Microsoft.OpenApi.Kiota&version=1.6.1
nuke :add-package Microsoft.OpenApi.Kiota --version 1.6.1


Dotnet CodeQL Coverage Sonarcloud Status

Kiota is a command line tool for generating an API client to call any OpenAPI described API you are interested in. The goal is to eliminate the need to take a dependency on a different API SDK for every API that you need to call. Kiota API clients provide a strongly typed experience with all the features you expect from a high quality API SDK, but without having to learn a new library for every HTTP API.

This library builds on top of the Microsoft.OpenAPI.NET library to ensure comprehensive support for APIs that use OpenAPI descriptions. One of the goals of the project is to provide the best code generator support possible for OpenAPI and JSON Schema features. The conceptual documentation describes how kiota works and the high level concepts, this readme documents how to get started with Kiota.

Getting started

Generating SDKs

  1. Install required tools and dependencies. (refer to the Supported Languages table under the Required tools & dependencies column)
  2. Get Kiota using one of the available options.
  3. Generate your API client, checkout the Parameters reference for the different options.
  4. Start calling your API using your fluent API Client.

Supported languages

The following table provides an overview of the languages supported by Kiota and the progress in the implementation of the different components.

Language Generation Abstractions Serialization Authentication HTTP Required tools & dependencies
CSharp FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
Go FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
Java FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link
PHP JSON, ❌ FORM, ❌ MULTIPART, TEXT Anonymous, ✔️ PHP League link
Python ❌ FORM, JSON, ❌ MULTIPART, TEXT Anonymous, Azure link
Ruby ❌ FORM, JSON, ❌ MULTIPART, ❌ TEXT Anonymous, ✔️ OAuth2 link
CLI (see CSharp) + (see CSharp) (see CSharp) (see CSharp) link
Swift ❌ FORM, ❌ JSON, ❌ FORM, ❌ TEXT Anonymous, ❌ Azure
TypeScript/JavaScript FORM, JSON, MULTIPART, TEXT Anonymous, API Key, Azure link

Legend: ✔ → in preview, ❌ → not started, ▶ → in progress.

Parameters reference

Parameters are documented here.


Make sure you install the pre-requisites first. If you are using Visual Studio Code as your IDE, the launch.json file already contains the configuration to run Kiota. By default this configuration will use the openApiDocs/v1.0/Mail.yml under the PowerShell repository as the OpenAPI to generate an SDK for. By default this configuration will output the generated files in a graphdotnetv4|graphjavav4|graphtypescriptv4 folder located in the parent folder this repository is cloned in.

Selecting the language you want to generate an API client for in the Visual Studio Debug tab and hitting F5 will automatically build, start, and attach the debugging process to Kiota.


You can find samples of clients generated with Kiota in the Kiota samples repository.

An example of an application that is calling multiple API can be found in the KiotaApp repo


This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.


This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.7.0-preview.202309280001 26 9/28/2023
1.7.0-preview.202309210001 47 9/21/2023
1.6.1 5,964 9/11/2023
1.6.0-preview.202309070001 48 9/7/2023
1.6.0-preview.202308310001 61 8/31/2023
1.6.0-preview.202308240001 59 8/24/2023
1.5.1 9,434 8/9/2023
1.5.0 1,923 8/4/2023
1.5.0-preview.202308030001 66 8/3/2023
1.5.0-preview.202307270001 63 7/27/2023
1.5.0-preview.202307200001 2,019 7/20/2023
1.5.0-preview.202307170006 65 7/17/2023
1.4.0 6,514 7/10/2023
1.4.0-preview.202307140002 54 7/14/2023
1.4.0-preview.202307140001 58 7/14/2023
1.4.0-preview.202307130012 58 7/13/2023
1.4.0-preview.202307130004 62 7/13/2023
1.4.0-preview.202307130003 62 7/13/2023
1.3.0 10,581 6/9/2023
1.2.1 6,157 5/17/2023
1.2.0 2,341 5/4/2023
1.1.3 12,601 4/18/2023
1.1.2 383 4/17/2023
1.1.1 2,880 4/5/2023
1.1.0 187 4/5/2023
1.0.1 8,546 3/9/2023
1.0.0 179 3/9/2023
0.11.1-preview 6,627 2/13/2023
0.11.0-preview 1,424 2/7/2023
0.10.0-preview 2,643 1/4/2023
0.9.0-preview 123 12/19/2022
0.8.3-preview 128 12/1/2022
0.7.1-preview 125 11/1/2022
0.6.0-preview 131 10/7/2022
0.5.1-preview 142 9/9/2022
0.5.0-preview 121 9/8/2022
0.4.0-preview 129 8/18/2022
0.3.0-preview 163 7/8/2022
0.2.1-preview 157 5/30/2022
0.2.0-preview 136 5/24/2022
0.1.3-preview 115 5/9/2022
0.1.2-preview 127 5/9/2022
0.1.1-preview 117 5/6/2022
0.1.0-preview 138 5/5/2022