DevelopersHow to connect an assistantKeys
Reference/People/Create

Ask to join by link

POSThttps://api.getwerk.ai/api/v1/project-invitation-links/request

Sends a request to join the project an invitation link leads to, for the owner and admins to answer.

Until it is accepted the key's person sees only the project's name. Asking again on the same link answers the request already sent; a person makes at most 10 attempts an hour.

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.

urlstringRequired

The invitation link, as shared.

Response

200 The request to join, or why none was sent.

One of 2 shapes:

With request
requestobject

The request to join.

Show properties of requestHide properties of request
idstring, uuid

The join request's id.

versioninteger

The request's version; an answer to it sends it as expectedVersion.

At least 1
stateenum

pending while it waits for an answer, approved or rejected once answered, cancelled when the link it came from was revoked, expired when nobody answered in time.

Allowed valuespendingapprovedrejectedcancelledexpired
createdAtstring, date-time

When the request was sent.

expiresAtstring, date-time

When the request lapses if nobody answers it.

resolvedAtstring, date-time or null

When it was answered, cancelled or lapsed, or null while pending.

projectNamestring

The name of the project the request is for.

With kind
kindenum

invalid, expired or revoked when the link does not work; already_member when the key's person is in the project.

Allowed valuesinvalidexpiredrevokedalready_member

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_people_requestThe people request 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
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 POST "https://api.getwerk.ai/api/v1/project-invitation-links/request" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d09",
    "url": "https://getwerk.ai/join/hs7Kq2mP9xRt4LwBvN3cJ8yZa5Qe1Ud6Gh0Fk2Ts9Xp"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/project-invitation-links/request", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d09",
    "url": "https://getwerk.ai/join/hs7Kq2mP9xRt4LwBvN3cJ8yZa5Qe1Ud6Gh0Fk2Ts9Xp"
  }),
});
const answer = await res.json();
200JSON
{
  "request": {
    "id": "a9d3f7b1-6e0c-4a28-b4d6-9e5f7c1a3d75",
    "version": 1,
    "state": "pending",
    "createdAt": "2026-11-20T18:10:00.000Z",
    "expiresAt": "2026-12-20T18:10:00.000Z",
    "resolvedAt": null,
    "projectName": "Harbor Street kitchen"
  }
}