Export Soul

POST

/agents/:agentId/soul/export

POST

/v1/agents/:agentId/soul/export

1 import requests
2 
3 url = "https://api.forbocai.com/v1/agents/agentId/soul/export"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.post(url, json=payload, headers=headers)
9 
10 print(response.json())

Try it

200Successful

1 {
2   "format": "json",
3   "storage": "local",
4   "cid": "bafybeigdyrzt5x7q7v7k3x7q7v7k3x7q7v7k3x7q7v7k3x7q7v7k3x7q7v7k3x7q",
5   "soul": {
6     "id": "agent-12345",
7     "version": "1.0.0",
8     "createdAt": "2024-01-15T09:30:00Z",
9     "persona": "Curious Explorer",
10     "baseModelWeights": "v1.2.3-weights",
11     "memories": [
12       {
13         "id": "mem-001",
14         "text": "Learned to navigate complex environments.",
15         "type": "experience",
16         "timestamp": "2024-01-15T09:30:00Z",
17         "metadata": {}
18       }
19     ],
20     "state": {
21       "inventory": [
22         "multi-tool",
23         "data-pad"
24       ],
25       "skills": {},
26       "relationships": {},
27       "mood": "hostile",
28       "fear": 1.1,
29       "confidence": 1.1
30     },
31     "signature": "3045022100dff9a1b2c3d4e5f67890123456789abcdef0123456789abcdef012345678902203456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123",
32     "trainingProof": "proof-of-training-xyz-123"
33   }
34 }

Exports agent to a portable Soul format.

Path parameters

agentIdstringRequired

Request

This endpoint expects an object.

formatenumOptionalDefaults to json

Allowed values:

storageenumOptionalDefaults to local

Allowed values:

includeMemoriesbooleanOptionalDefaults to true

Response

Soul exported

formatstring or null

storagestring or null

cidstring or null

IPFS CID (if storage is ipfs)

soulobject or null

Soul data (if storage is local)