Get Soul by CID

GET

/souls/:cid

GET

/v1/souls/:cid

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

Try it

200Retrieved

1 {
2   "id": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
3   "version": "1.0.3",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "persona": "Elder Sage",
6   "baseModelWeights": "gpt-4-weights-v1.2",
7   "memories": [
8     {
9       "id": "mem-20240115-093000",
10       "text": "Remembered the ancient prophecy about the coming storm.",
11       "type": "prophecy",
12       "timestamp": "2024-01-15T09:30:00Z",
13       "metadata": {
14         "source": "ancient scroll",
15         "importance": "high"
16       }
17     }
18   ],
19   "state": {
20     "inventory": [
21       "ancient staff",
22       "healing herbs"
23     ],
24     "skills": {
25       "wisdom": 95,
26       "alchemy": 80,
27       "combat": 40
28     },
29     "relationships": {
30       "village_chief": 0.8,
31       "forest_spirit": 0.6
32     },
33     "mood": "neutral",
34     "fear": 0.2,
35     "confidence": 0.85
36   },
37   "signature": "3045022100dff9a1b2c3d4e5f67890123456789abcdef0123456789abcdef012345678902203456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef01",
38   "trainingProof": "sha256:3a7bd3e2360a3d4f5e6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
39 }

Retrieves a Soul from IPFS by its CID.

Path parameters

cidstringRequired

Response

Soul data

idstring or null

versionstring or null

createdAtdatetime or null

personastring or null

baseModelWeightsstring or null

memorieslist of objects or null

stateobject or null

signaturestring or null

trainingProofstring or null