Skip to navigation
API ReferenceSDKs

Generate an SDK

View as Markdown

Creates an asynchronous generation job for a single SDK (in one language) from a collection or specification.

To get the status of an SDK’s generation, use the GET /sdks/{sdkId} endpoint and track its buildStatus. When the status is the succeeded value, the SDK is ready to download. You can also use the URL in the POST response’s Location header.

Note:

The request body is determined by the given language value, so only provide the properties relevant to that language’s SDK.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
sourceobjectRequired
The collection or specification that the SDK is generated from.
languageenumRequired
The target output language for the generated SDK.
sdkVersionstringOptional

An optional override for the SDK version. If this isn’t provided, the next version is resolved from the latest auto-pull request.

authorslist of objectsOptional
A list of package authors written into the generated manifest.
retryobjectOptional

Retry behavior baked into the generated SDK’s HTTP client. A power-user option; sensible defaults apply for any field left unset.

typescriptOptionsobjectOptional

TypeScript-specific SDK generation options.

pythonOptionsobjectOptional

Python-specific SDK generation options.

goOptionsobjectOptional

Go-specific SDK generation options.

javaOptionsobjectOptional

Java-specific SDK generation options.

csharpOptionsobjectOptional

C#-specific SDK generation options.

rubyOptionsobjectOptional

Ruby-specific generation options.

phpOptionsobjectOptional

PHP-specific SDK generation options.

kotlinOptionsobjectOptional

Kotlin-specific SDK generation options.

rustOptionsobjectOptional

Rust-specific SDK generation options.

cliOptionsobjectOptional

CLI-specific SDK generation options.

Response headers

LocationstringOptionalformat: "uri"
The URL of the created SDK resource.

Response

Successful Response

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error