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

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.agent_versioning_versions.update_version_metadata_label_description_pin_only(
8     id="id",
9     version_id="versionId",
10 )

1 {
2   "status": true,
3   "data": {
4     "_id": "5f8d0d55b54764421b7156c1",
5     "agent": "5f8d0d55b54764421b7156b9",
6     "status": "published",
7     "versionNumber": 3,
8     "label": "Q2 2024 Update",
9     "description": "Updated greeting prompts and call handling logic for improved user experience.",
10     "isPinned": true,
11     "publishedBy": "user_12345",
12     "publishedAt": "2024-01-15T09:30:00Z",
13     "activatedBy": "user_12345",
14     "activatedAt": "2024-01-15T09:30:00Z",
15     "draftId": "5f8d0d55b54764421b7156d0",
16     "draftName": "Q2 Feature Enhancements",
17     "draftRevision": 2,
18     "sourceVersionId": "5f8d0d55b54764421b7156bf",
19     "blocks": {
20       "workflow_prompt": "block_001",
21       "workflow_tools": "block_002",
22       "workflow_graph": "block_003",
23       "llm": "block_004",
24       "voice": "block_005",
25       "language": "block_006",
26       "call_handling": "block_007",
27       "detection": "block_008",
28       "analytics": "block_009",
29       "timeouts": "block_010",
30       "audio": "block_011",
31       "privacy": "block_012",
32       "widget": "block_013"
33     },
34     "workflowType": "workflow_graph",
35     "parentVersion": "5f8d0d55b54764421b7156be",
36     "isActive": true,
37     "createdBy": "user_12345",
38     "createdAt": "2024-01-10T08:00:00Z",
39     "updatedAt": "2024-01-15T09:30:00Z"
40   }
41 }

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.

**Deprecated on the v2 branch model.** Migrate to `Metadata edits removed on v2. Set `label` at publish via `POST /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](/voice-agents/deprecations/agent-versioning-migration). | 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

statusboolean

dataobject

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