AI Notes

This API is for the AI Notes resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically upload AI notes.

POSTadvisor-api.wealth.com/v1/ai-notes/{wid}

Upload AI Notes

This endpoint expects a wid for the top account to be passed as part of the URL.
upload_uri is url to which document content should be posted. The document's file extension is expected to be .json for this endpoint. See Using Upload URI for detailed upload instructions.

Upload AI Notes Request Object

Name
name
Type
string (Max 200)
Description
The file name of the document to be uploaded.

Request

POST

advisor-api.wealth.com/v1/ai-notes/{wid}

  curl --location 'https://advisor-api.wealth.com/v1/ai-notes/786bb91c-35ec-49bb-bc28-1d2930d7db6a' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx' \
    --data-raw '{
        "name": "john-doe-slat"
    }'

Upload AI Notes Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the client.
Name
vault_id
Type
string (Max 64)
Description
Wealth.com unique identifier for the document.
Name
upload_uri
Type
string (Max 2000)
Description
A secure link to upload the file. See Using Upload URI for detailed upload instructions.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
   "upload_uri": "https://vault.files.wealth.com/upload/..."
}

Error Responses

Status Code	Error Message	Description
400	Bad Request	Missing required parameter (`name`)
403	Access Denied	Invalid authorization token or insufficient permissions
404	Container not found	The specified client (`wid`) does not exist
500	Internal Server Error	Unexpected server error