Octri API
POST/api/v1/projects/{projectId}/sdk/trigger

Trigger an SDK build

Triggers an asynchronous SDK build of the current project spec for the requested languages. Supply languages; you can also set shared preferences, per-language languagePreferences, a semantic version, or a releaseRevision. Poll listSdkBuilds until the build reaches a final status, then retrieve its artifacts with listSdkBuildArtifacts.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
projectIdstringrequired

The project's unique identifier, obtained from listProjects.

SDK build configuration. languages is required; the other fields let you set generator options and build version details.

languagePreferencesobjectoptional

Overrides per language, merged over preferences. Keyed by language.

languagesarray<string>required

Languages to build: typescript, python, go, java, ruby, php, rust, swift, kotlin, or dart. Include at least one language.

preferencesobjectoptional

Generator options, the same ones SDK Studio saves.

releaseRevisionintegeroptional

The SDK Studio release revision to build. The build is refused if it has changed.

versionstringoptional

The semantic version to give the SDKs.

6 status codes
202Returns the queued build's buildId and a message confirming that the build was queued.
buildIdstringrequired
messagestringrequired
400Returned when the request fails validation.
errorobjectrequired
401Returned when the API key is missing or invalid.
errorobjectrequired
403Returned when the plan does not include the requested number of languages or a language is not active on the subscription.
errorobjectrequired
404Returned when the project or resource does not exist in the organisation.
errorobjectrequired
409Returned when the project has no current spec or the SDK release changes while the build is queued.
errorobjectrequired

Error handling

A 400 is returned when request validation fails; a 401 when the API key is missing or invalid; a 403 when the plan does not include the requested number of languages or a language is not active on the subscription; a 404 when the project or resource does not exist in the organisation; and a 409 when there is no current spec or the SDK release changes while the build is queued. The projectId path parameter must identify a project in the organisation. languages must contain at least one supported language, version must match the specified semantic version format, and releaseRevision must be at least 1.