DevelopersHow to connect an assistantKeys
Reference/Profile/Change

Change the photo

PUThttps://api.getwerk.ai/api/v1/account/photo

Sets the key's person's photo from a JPEG uploaded first with POST /assets.

The photo must fit the size a person's photo takes. Everyone in their projects sees it.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Body

clientRequestIdstring, uuidRequired

An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.

assetIdstring, uuidRequired

A photo uploaded first with POST /assets, made the key's person's photo.

Response

200 The photo after the change.

photoobject or null

The key's person's photo after the change, or null when removed.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1

Errors

400invalid_queryThe query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400invalid_attachmentA file the request names, or the way it names it, is not one the request takes there; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400photo_side_too_largeThe photo's longer side has more pixels than this request takes.
400unsupported_media_typeThe file's type is not one the route takes.
400invalid_mediaThe file, its name or the request about it is not in a form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404asset_not_foundThe file the request names is not one the signed-in person can reach where the request names it, or is no longer available.
409session_changedThe session changed while the request was in flight.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409request_erasedThe request id belongs to a request whose record was erased.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl -X PUT "https://api.getwerk.ai/api/v1/account/photo" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c04",
    "assetId": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/account/photo", {
  method: "PUT",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c04",
    "assetId": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82"
  }),
});
const answer = await res.json();
200JSON
{
  "photo": {
    "personId": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
    "version": 2
  }
}