Update a brain

Update a brain's name, description, emoji, usage hint, visibility or skills. Omitted fields are left as they are.

PATCH

https://truememory-api.mvstg.com/brains/{brain_id}

View as Markdown

Authorization

HTTPBearerHTTPrequired

Path parameters

brain_idstringrequired
format: uuid

Header parameters

X-On-Behalf-Ofoptional
One of the following:
string
null
}
X-External-User-Idoptional
One of the following:
string
null
}
X-App-Idoptional
One of the following:
string
null
}

Request bodyJSONrequired

nameoptional
One of the following:
string
null
}
descriptionoptional
One of the following:
string
null
}
emojioptional
One of the following:
string
null
}
usage_hintoptional
One of the following:
string
null
}
visibilityoptional
One of the following:
string
null
}
skill_idsoptional
One of the following:
array<string>
null
}

Returns

200

Successful Response

JSON

idstringrequired
user_idrequired
One of the following:
string
null
}
app_idrequired
One of the following:
string
null
}
namestringrequired
descriptionrequired
One of the following:
string
null
}
created_atstringrequired
format: date-time
updated_atstringrequired
format: date-time
skill_idsarray ofstringrequired
Ids of skills, for clients that only need to seed a multi-select.

Derived rather than stored so it cannot disagree with skills.
emojioptional
One of the following:
string
null
}
usage_hintoptional
One of the following:
string
null
}
visibilityoptionalprivateorapporpublic
default: "private"
skillsoptionalarray ofobject
- idstringrequired
- keystringrequired
- namestringrequired
}
document_countoptionalinteger
default: 0

422

Validation Error

JSON

detailoptionalarray ofobject
- locarray ofrequired
  One of the following:
  string
  integer
- msgstringrequired
- typestringrequired
- inputoptionalunknown
- ctxoptionalobject
}

curl --request PATCH \ --url 'https://truememory-api.mvstg.com/brains/<brain_id>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string", "emoji": "string", "usage_hint": "string", "visibility": "private", "skill_ids": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } '

{ "id": "string", "user_id": "string", "app_id": "string", "name": "string", "description": "string", "emoji": "string", "usage_hint": "string", "visibility": "private", "skills": [ { "id": "string", "key": "string", "name": "string" } ], "document_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "skill_ids": [ "string" ] }