Skip to content
Workshape Catalyst Operator Docs

Account

Read the signed-in user with effective permissions

Section titled “Read the signed-in user with effective permissions”

GET /api/v1/me

Operation
me.get
Accepts
sessionCookie, sessionToken
Scope
me:read
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: ApiUser

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Change the signed-in user’s profile

Section titled “Change the signed-in user’s profile”

PATCH /api/v1/me

Operation
me.update
Accepts
sessionCookie, sessionToken
Scope
me:write
Effect
changing
Rate class
write

Request body

application/json: UpdateCurrentUserRequest

Answers

  • 200 The result

    application/json: ApiUser

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Delete the signed-in user’s account and data. Answers 202 when the account is closed and its data is still being removed.

Section titled “Delete the signed-in user’s account and data. Answers 202 when the account is closed and its data is still being removed.”

DELETE /api/v1/me

Operation
me.delete
Accepts
sessionCookie, sessionToken
Scope
me:delete
Effect
changing
Rate class
write

Answers

  • 200 The result

    application/json: DeleteCurrentUserResponse

  • 202 The call was accepted and its work finishes by itself. The answer has no body.
  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read the signed-in user’s model preference

Section titled “Read the signed-in user’s model preference”

GET /api/v1/me/model-preference

Operation
me.model_preference.get
Accepts
sessionCookie, sessionToken
Scope
me:read
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: UserModelPreference

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Replace the signed-in user’s model preference

Section titled “Replace the signed-in user’s model preference”

PUT /api/v1/me/model-preference

Operation
me.model_preference.set
Accepts
sessionCookie, sessionToken
Scope
me:write
Effect
changing
Rate class
write

Request body

application/json: UserModelPreference

Answers

  • 200 The result

    application/json: UserModelPreference

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Change the signed-in user’s password

Section titled “Change the signed-in user’s password”

POST /api/v1/me/password

Operation
me.password.change
Accepts
sessionCookie, sessionToken
Scope
me:write
Effect
changing
Rate class
auth

Request body

application/json: ChangeCurrentUserPasswordRequest

Answers

  • 200 The result

    application/json: ChangeCurrentUserPasswordResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Send a password reset mail to a locked-out user

Section titled “Send a password reset mail to a locked-out user”

POST /api/v1/password-reset

Operation
password_reset.request
Accepts
No credential
Effect
changing
Rate class
auth

Parameters

  • locale string in query, optional

Request body

application/json: RequestPasswordResetRequest

Answers

  • 200 The result

    application/json: RequestPasswordResetResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Set a password with a setup or reset token

Section titled “Set a password with a setup or reset token”

POST /api/v1/password-setup

Operation
password_setup.complete
Accepts
No credential
Effect
changing
Rate class
auth

Request body

application/json: CompletePasswordSetupRequest

Answers

  • 200 The result

    application/json: CompletePasswordSetupResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.