Change a project's photo
PUThttps://api.getwerk.ai/api/v1/projects/{projectId}/photo
Sets the project's photo, from a JPEG sent as the body or from an upload made first with POST /assets.
The project's owner and admins may change it. The photo must be square and within the project photo's size.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Headers
Idempotency-Keystring, uuidRequired
An id the caller makes for this request; sent again with it, the request changes nothing twice.
Path parameters
projectIdstring, uuidRequired
The project's id.
Body
assetIdstring, uuidRequired
A photo uploaded first with POST /assets, made the project's new photo.
Response
200 The project's new photo.
photoobject
The project's photo after the change.
Show properties of photoHide properties of photo
versioninteger
The photo's version, which changes with the photo; its read takes it to fetch the current one.
At least 1
Errors
400
invalid_query The 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).400
invalid_idempotency_key The Idempotency-Key header is not a uuid.400
invalid_media The 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).400
unsupported_media_type The file's type is not one the route takes.400
photo_side_too_large The photo's longer side has more pixels than this request takes.401
session_revoked The request carries no session the server holds, or its session has ended.401
session_expired The session has expired.403
project_not_permitted The signed-in person's role in the project does not allow this request on the project.404
conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.404
asset_not_found The file the request names is not one the signed-in person can reach where the request names it, or is no longer available.409
session_changed The session changed while the request was in flight.409
project_deleted The project is being deleted.409
project_archived The project is archived, so it does not take this request.409
idempotency_conflict The request's key, or the upload address it was sent to, was already used with other content.409
request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.413
payload_too_large The request body has more bytes than the route takes.429
rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.500
server_error The 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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/photo" \
-H "Authorization: Bearer wk_key_..." \
-H "Idempotency-Key: f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b03" \
-H "Content-Type: application/json" \
-d '{
"assetId": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82"
}'TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/photo", {
method: "PUT",
headers: {
Authorization: "Bearer wk_key_...",
"Idempotency-Key": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b03",
"Content-Type": "application/json",
},
body: JSON.stringify({
"assetId": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82"
}),
});
const answer = await res.json();200JSON
{
"photo": {
"version": 3
}
}Send a requestPUT
This request cannot be sent from this page. Run its example instead.