Publish a draft

Deprecated

POST

https://api.smallest.ai/atoms/v1/agent/:id/drafts/:draftId/publish

POST

/atoms/v1/agent/:id/drafts/:draftId/publish

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.agent_versioning_drafts.publish_a_draft(
8     id="id",
9     draft_id="draftId",
10 )

1 {
2   "status": true,
3   "data": {
4     "_id": "642f1b2e9a1c4e3f8b7d9a12",
5     "agent": "5f8d0d55b54764421b7156c3",
6     "status": "published",
7     "versionNumber": 3,
8     "label": "Release 3.0 - Improved NLP",
9     "description": "This version includes enhanced natural language processing capabilities and bug fixes.",
10     "isPinned": false,
11     "publishedBy": "user_987654321",
12     "publishedAt": "2024-01-15T09:30:00Z",
13     "activatedBy": "user_987654321",
14     "activatedAt": "2024-01-15T09:30:00Z",
15     "draftId": "draft_123456789",
16     "draftName": "NLP Improvements Draft",
17     "draftRevision": 5,
18     "sourceVersionId": "642f1b2e9a1c4e3f8b7d9a10",
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": "642f1b2e9a1c4e3f8b7d9a11",
36     "isActive": true,
37     "createdBy": "user_123456789",
38     "createdAt": "2023-12-20T14:00:00Z",
39     "updatedAt": "2024-01-15T09:30:00Z"
40   }
41 }

Deprecated on the v2 branch model. Migrate to 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.

Publish a draft as a new versioned release. Optionally activate it immediately.

**Deprecated on the v2 branch model.** Migrate to `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). Publish a draft as a new versioned release. Optionally activate it immediately.

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.

draftIdstringRequired

The draft ID

Request

This endpoint expects an object.

labelstring or nullOptional<=200 characters

Label for the published version

descriptionstring or nullOptional<=2000 characters

Description of the published version

activatebooleanOptionalDefaults to false

Whether to immediately activate the version after publishing

Response

Draft published as a new version

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