> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/developers/account-and-keys/user.md).

# User

The signed-in user's profile. `GET /user` returns the user the API key belongs to.

## GET /user

> Get user data for a user id

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UserMetadataDTO":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"onboarding_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Status"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupation"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"used_desktop_app":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used Desktop App"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"},"id":{"type":"string","format":"uuid","title":"Id"},"is_shade_admin":{"type":"boolean","title":"Is Shade Admin"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_roots":{"type":"integer","title":"Total Roots"},"plan_status":{"$ref":"#/components/schemas/UserPlanStatus"},"plan":{"$ref":"#/components/schemas/UserPlan"},"asset_limit":{"type":"integer","title":"Asset Limit"},"total_indexed":{"type":"integer","title":"Total Indexed"},"total_storage":{"type":"integer","title":"Total Storage"}},"type":"object","required":["id","is_shade_admin","created_at","total_roots","plan_status","plan","asset_limit","total_indexed","total_storage"],"title":"UserMetadataDTO"},"UserPlanStatus":{"type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","guest"],"title":"UserPlanStatus"},"UserPlan":{"type":"string","enum":["free","guest","pro","pro-life"],"title":"UserPlan"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user":{"get":{"tags":["user"],"summary":"Get user data for a user id","operationId":"getUser","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserMetadataDTO"},{"type":"null"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## PUT /user

> Modify user data

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateUserRequest":{"properties":{"user":{"$ref":"#/components/schemas/UpdatableUserMetadataDTO","title":"Updated user","description":"The updated user object"}},"type":"object","required":["user"],"title":"UpdateUserRequest"},"UpdatableUserMetadataDTO":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"onboarding_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Status"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupation"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"used_desktop_app":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used Desktop App"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"}},"type":"object","title":"UpdatableUserMetadataDTO"},"UserMetadataDTO":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"onboarding_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Status"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupation"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"used_desktop_app":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used Desktop App"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"},"id":{"type":"string","format":"uuid","title":"Id"},"is_shade_admin":{"type":"boolean","title":"Is Shade Admin"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_roots":{"type":"integer","title":"Total Roots"},"plan_status":{"$ref":"#/components/schemas/UserPlanStatus"},"plan":{"$ref":"#/components/schemas/UserPlan"},"asset_limit":{"type":"integer","title":"Asset Limit"},"total_indexed":{"type":"integer","title":"Total Indexed"},"total_storage":{"type":"integer","title":"Total Storage"}},"type":"object","required":["id","is_shade_admin","created_at","total_roots","plan_status","plan","asset_limit","total_indexed","total_storage"],"title":"UserMetadataDTO"},"UserPlanStatus":{"type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","guest"],"title":"UserPlanStatus"},"UserPlan":{"type":"string","enum":["free","guest","pro","pro-life"],"title":"UserPlan"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user":{"put":{"tags":["user"],"summary":"Modify user data","operationId":"updateUser","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserMetadataDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Delete the signed-in user's account

> Delete the user's account. Remove them from every shared workspace and\
> flag the row deleted (which revokes access), committing both before the\
> WorkOS call. The personal workspace stays with the anonymized account.\
> Personal information is always obfuscated as part of deletion.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user":{"delete":{"tags":["user"],"summary":"Delete the signed-in user's account","description":"Delete the user's account. Remove them from every shared workspace and\nflag the row deleted (which revokes access), committing both before the\nWorkOS call. The personal workspace stays with the anonymized account.\nPersonal information is always obfuscated as part of deletion.","operationId":"deleteUser","responses":{"204":{"description":"Successful Response"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /user/profile/avatar/upload-url

> Create an avatar for a user

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UserCreateAvatarUploadUrlRequest":{"properties":{"extension":{"type":"string","enum":["png","jpg","jpeg"],"title":"Extension","description":"The extension type of the avatar"},"size":{"title":"Size","description":"Size of the avatar"}},"type":"object","required":["extension","size"],"title":"UserCreateAvatarUploadUrlRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user/profile/avatar/upload-url":{"post":{"tags":["user"],"summary":"Create an avatar for a user","operationId":"userCreateAvatarUploadUrl","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateAvatarUploadUrlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /user/profile/avatar/complete

> Confirm uploading an avatar for a user

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UserCompleteAvatarRequest":{"properties":{"download_url":{"title":"Download url","description":"The download url"}},"type":"object","required":["download_url"],"title":"UserCompleteAvatarRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user/profile/avatar/complete":{"post":{"tags":["user"],"summary":"Confirm uploading an avatar for a user","operationId":"userCompleteAvatar","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCompleteAvatarRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /user/share

> Create user for share to perform actions with

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"CreateShareUserRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the user"},"email":{"type":"string","title":"Email","description":"The email of the user"}},"type":"object","required":["name","email"],"title":"CreateShareUserRequest"},"UserMetadataDTO":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"onboarding_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Status"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupation"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"used_desktop_app":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used Desktop App"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"},"id":{"type":"string","format":"uuid","title":"Id"},"is_shade_admin":{"type":"boolean","title":"Is Shade Admin"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_roots":{"type":"integer","title":"Total Roots"},"plan_status":{"$ref":"#/components/schemas/UserPlanStatus"},"plan":{"$ref":"#/components/schemas/UserPlan"},"asset_limit":{"type":"integer","title":"Asset Limit"},"total_indexed":{"type":"integer","title":"Total Indexed"},"total_storage":{"type":"integer","title":"Total Storage"}},"type":"object","required":["id","is_shade_admin","created_at","total_roots","plan_status","plan","asset_limit","total_indexed","total_storage"],"title":"UserMetadataDTO"},"UserPlanStatus":{"type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","guest"],"title":"UserPlanStatus"},"UserPlan":{"type":"string","enum":["free","guest","pro","pro-life"],"title":"UserPlan"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user/share":{"post":{"tags":["user"],"summary":"Create user for share to perform actions with","operationId":"createShareUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShareUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserMetadataDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Update user email

> Update the user's email in both WorkOS and the local database.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateEmailRequest":{"properties":{"new_email":{"type":"string","format":"email","title":"New Email"}},"type":"object","required":["new_email"],"title":"UpdateEmailRequest"},"UserMetadataDTO":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"onboarding_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Status"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar Url"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupation"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"referral_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Source"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"used_desktop_app":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used Desktop App"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"},"id":{"type":"string","format":"uuid","title":"Id"},"is_shade_admin":{"type":"boolean","title":"Is Shade Admin"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_roots":{"type":"integer","title":"Total Roots"},"plan_status":{"$ref":"#/components/schemas/UserPlanStatus"},"plan":{"$ref":"#/components/schemas/UserPlan"},"asset_limit":{"type":"integer","title":"Asset Limit"},"total_indexed":{"type":"integer","title":"Total Indexed"},"total_storage":{"type":"integer","title":"Total Storage"}},"type":"object","required":["id","is_shade_admin","created_at","total_roots","plan_status","plan","asset_limit","total_indexed","total_storage"],"title":"UserMetadataDTO"},"UserPlanStatus":{"type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","guest"],"title":"UserPlanStatus"},"UserPlan":{"type":"string","enum":["free","guest","pro","pro-life"],"title":"UserPlan"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user/email":{"put":{"tags":["user"],"summary":"Update user email","description":"Update the user's email in both WorkOS and the local database.","operationId":"updateUserEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserMetadataDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Request a password reset email

> Send a password reset email to the user via WorkOS.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"user","description":"The signed-in user's profile. `GET /user` returns the user the API key\nbelongs to."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"RequestPasswordResetResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"RequestPasswordResetResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/user/request-password-reset":{"post":{"tags":["user"],"summary":"Request a password reset email","description":"Send a password reset email to the user via WorkOS.","operationId":"requestPasswordReset","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPasswordResetResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/account-and-keys/user.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
