Diff two revisions or drafts

GET

https://api.smallest.ai/atoms/v1/agent/:id/diff

GET

/atoms/v1/agent/:id/diff

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/id/diff"
4 
5 querystring = {"a":"a","b":"b"}
6 
7 payload = {}
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "unchangedSections": [
5       "intents"
6     ],
7     "diffs": [
8       {
9         "section": "entities",
10         "changes": [
11           {
12             "path": "entities.userLocation.type",
13             "oldValue": "string",
14             "newValue": "geo_coordinates"
15           },
16           {
17             "path": "entities.userAge.required",
18             "oldValue": true,
19             "newValue": false
20           }
21         ]
22       }
23     ]
24   }
25 }

Compare any two references on this agent and return per-section diffs. Each side (a and b) is either a revisionId or the string <branchId>:draft to reference the open draft on a branch. Sides may cross branches. Both references must resolve to configs on the same agent.

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.

Query parameters

astringRequired1-64 characters

Left-hand side. Either a revisionId (24-hex ObjectId) or the token <branchId>:draft.

bstringRequired1-64 characters

Right-hand side. Either a revisionId (24-hex ObjectId) or the token <branchId>:draft.

Response

Successful response.

statusboolean

dataobject

Returned by GET /agent/{id}/diff.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error