Agent Versioning - Versions

Update version metadata (label, description, pin only)

Changed on

Deprecated on the v2 branch model. Migrate to Metadata edits removed on v2. Set labelat publish viaPOST /agent/{id}/branches/{branchId}/draft/publish.. When ENABLE_BRANCH_MODEL is on, this endpoint returns 409 versioning_v2_migration_required with the Deprecation: true header. See the migration guide.

| Update a published version's label, description, or pinned status. At least one field is required. Published versions (both active and inactive) are config-immutable — their agent configuration cannot be changed. To modify config, create a new draft from the version, edit the draft, and publish it as a new version.

patch/agent/{id}/versions/{versionId}

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent/{id}/versions/{versionId}
  • Auth
    HTTP bearer

Path parameters

idstring required

The agent ID.

versionIdstring required

The published version ID

Request body

labelstring nullable

Version label

descriptionstring nullable

Version description

isPinnedboolean

Pin or unpin the version

Response

Version metadata updated

statusboolean

Example response

{
  "status": true
}

Changes

  • 49ce8525306eRevision changes
    • warning

      added the new multi_agents enum value to the / response property for the response status

  • a9c928635312Revision changes
    • breaking

      added the pattern ^[a-f\d]{24}$ to the path request parameter id

    • info

      endpoint deprecated

    • info

      added the non-success response with the status