Update version metadata (label, description, pin only)

Deprecated

PATCH

https://api.smallest.ai/atoms/v1/agent/:id/versions/:versionId

PATCH

/atoms/v1/agent/:id/versions/:versionId

from smallestai import SmallestAI
client = SmallestAI(
    token="YOUR_TOKEN_HERE",
)
client.atoms.agent_versioning_versions.update_version_metadata_label_description_pin_only(
    id="id",
    version_id="versionId",
)

{
  "status": true,
  "data": {
    "_id": "string",
    "agent": "string",
    "status": "published",
    "versionNumber": 1,
    "label": "string",
    "description": "string",
    "isPinned": false,
    "publishedBy": "string",
    "publishedAt": "2024-01-15T09:30:00Z",
    "activatedBy": "string",
    "activatedAt": "2024-01-15T09:30:00Z",
    "draftId": "string",
    "draftName": "string",
    "draftRevision": 1,
    "sourceVersionId": "string",
    "blocks": {
      "workflow_prompt": "string",
      "workflow_tools": "string",
      "workflow_graph": "string",
      "llm": "string",
      "voice": "string",
      "language": "string",
      "call_handling": "string",
      "detection": "string",
      "analytics": "string",
      "timeouts": "string",
      "audio": "string",
      "privacy": "string",
      "widget": "string"
    },
    "workflowType": "workflow_graph",
    "parentVersion": "string",
    "isActive": true,
    "createdBy": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
}

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.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequiredformat: "^[a-f\d]{24}$"

The agent ID.

versionIdstringRequiredformat: "^[a-f\d]{24}$"

The published version ID

Request

This endpoint expects an object.

labelstring or nullOptional<=200 characters

Version label

descriptionstring or nullOptional<=2000 characters

Version description

isPinnedbooleanOptional

Pin or unpin the version

Response

Version metadata updated

statusbooleanOptional

dataobjectOptional

Represents either a draft revision or a published version of an agent's configuration.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error