Activate a version

PATCH

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

PATCH

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

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

1 {
2   "status": true,
3   "data": {
4     "_id": "60d0fe4f5311236168a109cb",
5     "agent": "60d0fe4f5311236168a109ca",
6     "status": "published",
7     "versionNumber": 3,
8     "label": "Q2 2024 Customer Support Update",
9     "description": "Updated call handling and voice settings to improve response accuracy and customer satisfaction.",
10     "isPinned": true,
11     "publishedBy": "user_8f3a2c1d",
12     "publishedAt": "2024-04-10T14:45:00Z",
13     "activatedBy": "user_8f3a2c1d",
14     "activatedAt": "2024-04-10T15:00:00Z",
15     "draftId": null,
16     "draftName": null,
17     "draftRevision": null,
18     "sourceVersionId": "60d0fe4f5311236168a109c9",
19     "blocks": {
20       "workflow_prompt": "prompt_block_03",
21       "workflow_tools": "tools_block_02",
22       "workflow_graph": "graph_block_05",
23       "llm": "llm_block_01",
24       "voice": "voice_block_04",
25       "language": "language_block_en_us",
26       "call_handling": "call_handling_block_07",
27       "detection": "detection_block_02",
28       "analytics": "analytics_block_01",
29       "timeouts": "timeouts_block_03",
30       "audio": "audio_block_06",
31       "privacy": "privacy_block_01",
32       "widget": "widget_block_02"
33     },
34     "workflowType": "workflow_graph",
35     "parentVersion": "60d0fe4f5311236168a109c8",
36     "isActive": true,
37     "createdBy": "user_7b2d1e4f",
38     "createdAt": "2024-04-05T10:20:00Z",
39     "updatedAt": "2024-04-10T14:50:00Z"
40   }
41 }

Set a published version as the active version for the agent. The previously active version is deactivated. This does not modify the version’s config — it only changes which version serves live traffic. Activation is idempotent: if the version is already active, the endpoint returns that version without changing config.

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

Response

Version activated successfully

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

500

Internal Server Error