Generate an SDK

POST

/sdks

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.

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

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

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.

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

Locationstring

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

$	curl -X POST https://api.getpostman.com/sdks \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"source": {
>	"type": "collection",
>	"id": "12ece9e1-2abf-4edc-8e34-de66e74114d2"
>	},
>	"language": "typescript",
>	"authors": [
>	{
>	"name": "engineering Engineering",
>	"email": "sdk@engineering.com"
>	}
>	],
>	"retry": {
>	"retryDelay": 200,
>	"maxAttempts": 5,
>	"httpCodesToRetry": [
>	429,
>	503
>	]
>	},
>	"typescriptOptions": {
>	"npmOrg": "@engineering",
>	"npmName": "engineering-sdk"
>	}
>	}'