Activate a version

Deprecated

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="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": "Q1 2024 Update",
9     "description": "Updated call routing logic and improved voice recognition accuracy.",
10     "isPinned": true,
11     "publishedBy": "user_12345",
12     "publishedAt": "2024-01-15T09:30:00Z",
13     "activatedBy": "user_67890",
14     "activatedAt": "2024-01-15T09:30:00Z",
15     "draftId": null,
16     "draftName": null,
17     "draftRevision": null,
18     "sourceVersionId": "5f8d0d55b54764421b7156bf",
19     "blocks": {
20       "workflow_prompt": "prompt_block_001",
21       "workflow_tools": "tools_block_002",
22       "workflow_graph": "graph_block_003",
23       "llm": "llm_block_004",
24       "voice": "voice_block_005",
25       "language": "language_block_006",
26       "call_handling": "call_handling_block_007",
27       "detection": "detection_block_008",
28       "analytics": "analytics_block_009",
29       "timeouts": "timeouts_block_010",
30       "audio": "audio_block_011",
31       "privacy": "privacy_block_012",
32       "widget": "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 POST /agent/{id}/branches/{branchId}/live or POST /agent/{id}/branches/{branchId}/revisions/{revisionId}/restore. When ENABLE_BRANCH_MODEL is on, this endpoint returns 409 versioning_v2_migration_required with the Deprecation: true header. See the migration guide.

| 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.

**Deprecated on the v2 branch model.** Migrate to `POST /agent/{id}/branches/{branchId}/live or POST /agent/{id}/branches/{branchId}/revisions/{revisionId}/restore`. 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). | 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

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

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

409

Conflict Error

500

Internal Server Error