Get Soul by TXID

GET

/souls/:txId

GET

/souls/:txId

curl https://api.forboc.ai/souls/txId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "id": "3f1e2d4c5b6a7890abcdef1234567890abcdef1234567890abcdef1234567890",
  "version": "1.0.3",
  "name": "Eldric the Wise",
  "persona": "A knowledgeable and calm wizard who guides adventurers through mystical realms.",
  "memories": [
    {
      "event": "Discovered ancient spellbook",
      "timestamp": "2024-04-10T15:22:30Z",
      "details": {
        "location": "Arcane Library, Tower of Elders",
        "importance": "high"
      }
    }
  ],
  "state": {
    "health": 85,
    "mana": 120,
    "location": "Mystic Forest",
    "questStatus": "active"
  },
  "signature": "MEUCIQDf7v9Xq2J7kLzYv9Xq2J7kLzYv9Xq2J7kLzYv9Xq2J7kLzYgIgXq2J7kLzYv9Xq2J7kLzYv9Xq2J7kLzYv9Xq2J7kLzYv9Xq2J7k="
}

Retrieves a Soul from Arweave by its data item ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

txIdstringRequired

Response

Soul data

idstringOptional

versionstringOptional

namestringOptional

personastringOptional

memorieslist of maps from strings to anyOptional

statemap from strings to anyOptional

signaturestring or nullOptional