Update version metadata (label, description, pin only)

import requests
url = "https://api.smallest.ai/atoms/v1/agent/60d0fe4f5311236168a109ca/versions/versionId"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "status": true,
  "data": {
    "_id": "60d0fe4f5311236168a109cb",
    "agent": "60d0fe4f5311236168a109ca",
    "status": "published",
    "versionNumber": 3,
    "label": "Q2 2024 Customer Support Update",
    "description": "Updated call handling and analytics blocks to improve response times and reporting accuracy.",
    "isPinned": true,
    "publishedBy": "user_987654321",
    "draftId": "60d0fe4f5311236168a109cc",
    "draftName": "Support Workflow Draft",
    "draftRevision": 2,
    "sourceVersionId": "60d0fe4f5311236168a109c9",
    "blocks": {
      "workflow_prompt": "block_001",
      "workflow_tools": "block_002",
      "workflow_graph": "block_003",
      "llm": "block_004",
      "voice": "block_005",
      "language": "block_006",
      "call_handling": "block_007",
      "detection": "block_008",
      "analytics": "block_009",
      "timeouts": "block_010",
      "audio": "block_011",
      "privacy": "block_012",
      "widget": "block_013"
    },
    "workflowType": "workflow_graph",
    "parentVersion": "60d0fe4f5311236168a109c8",
    "isActive": true,
    "createdBy": "user_123456789",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-04-10T14:45:00Z"
  }
}

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

idstringRequired

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

statusboolean

dataobject

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

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error