Skip to content
Astro Notes

Signs in with the recovery auth key.

POST
/v1/sessions:recover

The client then rewraps and changes the password.

Authorizations

Section titled “Authorizations”
  • None

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Account recovery sign-in using the recovery key.

object
identifier
required

Handle or email address.

string
recoveryAuthKey
required

Base64 recovery auth key derived from the recovery key.

string

Examplegenerated

{
  "identifier": "example",
  "recoveryAuthKey": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Session opened

Media typeapplication/json

Successful authentication response.

object
account
required

Account profile.

object
discoverableByEmail
required

Whether the verified email may resolve this user for sharing.

boolean
email
string
emailVerified
required
boolean
handle
string
id
required
string format: uuid
passkeys
required

What this account’s authenticators amount to. Its own object, as subscription and usage are: it answers one question, and the answer is nobody else’s business.

object
offerEnrolment
required

Whether to offer enrolling one. Server-computed, so the client shows an answer rather than assembling one from state it would first have to be told.

boolean
subscription
required

Subscription state mirrored from Stripe.

object
cancelAtPeriodEnd
required

True when an auto-renewing subscription ends at currentPeriodEnd.

boolean
currentPeriodEnd
string format: date-time
plan

Absent until a plan is purchased.

string
Allowed values: monthly yearly
status
required

Stripe’s subscription status verbatim. An open vocabulary Stripe owns, so an unknown status must reach the client rather than fail the response.

string
tier
required

Server-computed. Clients must not re-derive it from subscription.

string
Allowed values: free subscribed complimentary
usage
required

Account storage consumption against the tier’s aggregate ceiling.

object
accountBytes
required

Stored bytes across the account: live notes plus revision snapshots.

integer format: int64
maxAccountBytes
required

The tier’s aggregate storage ceiling, the sole storage limit.

integer format: int64
noteCount
required
integer format: int64
keys
required

Key material a client needs to unlock the account on this device.

object
kdfIterations
required
integer format: int32
kdfSalt
required

Base64 KDF salt.

string
publicKey

Base64 sharing public key. Absent until the client generates a keypair.

string
recoveryWrappedMasterKey
required

Base64 master key wrapped by the recovery key.

string
wrappedMasterKey
required

Base64 master key wrapped by the password-derived wrap key.

string
wrappedPrivateKey

Base64 sharing private key wrapped by the master key. Absent until set.

string
token
required

Opaque bearer token.

string

Example

{
  "account": {
    "subscription": {
      "plan": "monthly"
    },
    "tier": "free"
  }
}

400

Section titled “400”

The request is malformed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “401”

Authentication failed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

413

Section titled “413”

The body is too large

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

415

Section titled “415”

The body is not JSON

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Section titled “Headers”
Accept
string

The media type the operation takes.

429

Section titled “429”

Too many requests

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Section titled “Headers”
Retry-After
string

Seconds to wait. Sent when the limit knows when it lifts.

500

Section titled “500”

The service failed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

503

Section titled “503”

The service is at capacity

Media typeapplication/problem+json

RFC 9457 problem details payload.

object
detail

Explanation specific to this occurrence, written to help correct the request.

string
errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object
detail
required

What is wrong with it.

string
pointer
required

JSON Pointer to the member within the request body. Empty for the whole body.

string
status
required

HTTP status code.

integer format: int32
title
required

Short summary of the problem type. For about:blank, the status phrase.

string
type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Examplegenerated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}