> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.forboc.ai/api-reference/endpoints/forboc-ai-sdk-api/soul/export-soul/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.forboc.ai/_mcp/server. # Export Soul (Phase 1) POST https://api.forboc.ai/npcs/{npcId}/soul/export Content-Type: application/json Returns Arweave upload instruction and signed payload envelope. Reference: https://docs.forboc.ai/api-reference/endpoints/forboc-ai-sdk-api/soul/export-soul ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.forboc.ai` (ForbocAI API Production, default) - `http://localhost:8080` (Local Development) ## Request ### Path parameters - `npcId` (string, required) ### Body (application/json) This endpoint expects a SoulExportRequest. - `npcIdRef` (string, required) - `persona` (string, required) - `npcState` (map from string to any, required) ## Response ### 200 Soul export phase-1 response - `se1Instruction` (ArweaveUploadInstruction, required) - `se1SignedPayload` (map from string to any, required) - `se1Signature` (string, required) ## Types ### ArweaveUploadInstruction - `auiEndpoint` (string, required) - `auiPayload` (map from string to any, required) - `auiContentType` (string, required) - `auiAuthHeader` (string, optional, nullable) ## Examples **Request** ```json { "npcIdRef": "npc-12345-abcde", "persona": "Elder Sage of the Mystic Forest" } ``` **Response** ```json { "se1Instruction": { "auiEndpoint": "https://arweave.net/upload", "auiPayload": {}, "auiContentType": "application/json", "auiAuthHeader": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" }, "se1SignedPayload": {}, "se1Signature": "3045022100dff9a1e3b7a4c8e2f9a1b2c3d4e5f67890123456789abcdef0123456789abcdef02207b8e9f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e" } ``` **SDK Code** ```python import requests url = "https://api.forboc.ai/npcs/npcId/soul/export" payload = { "npcIdRef": "npc-12345-abcde", "persona": "Elder Sage of the Mystic Forest" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.forboc.ai/npcs/npcId/soul/export'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"npcIdRef":"npc-12345-abcde","persona":"Elder Sage of the Mystic Forest"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.forboc.ai/npcs/npcId/soul/export" payload := strings.NewReader("{\n \"npcIdRef\": \"npc-12345-abcde\",\n \"persona\": \"Elder Sage of the Mystic Forest\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.forboc.ai/npcs/npcId/soul/export") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"npcIdRef\": \"npc-12345-abcde\",\n \"persona\": \"Elder Sage of the Mystic Forest\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.forboc.ai/npcs/npcId/soul/export") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"npcIdRef\": \"npc-12345-abcde\",\n \"persona\": \"Elder Sage of the Mystic Forest\"\n}") .asString(); ``` ```php request('POST', 'https://api.forboc.ai/npcs/npcId/soul/export', [ 'body' => '{ "npcIdRef": "npc-12345-abcde", "persona": "Elder Sage of the Mystic Forest" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.forboc.ai/npcs/npcId/soul/export"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"npcIdRef\": \"npc-12345-abcde\",\n \"persona\": \"Elder Sage of the Mystic Forest\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "npcIdRef": "npc-12345-abcde", "persona": "Elder Sage of the Mystic Forest" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.forboc.ai/npcs/npcId/soul/export")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```