online.fg-goose.gsb.getSession Documentation (EN)

main query

The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.

Parameters

session string Required

No description available.

Output

Encodingapplication/json

expires integer Required

Home-world clock minute at which it is discarded if idle.

session string Required

`scratch/<name>`.

status string Required

world-status verdict.

Errors

AuthRequired

InvalidToken

InvalidRequest

RateLimitExceeded

RecordNotFound

HostUnavailable

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

session *

View raw schema

{
  "description": "The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.",
  "errors": [
    {
      "name": "AuthRequired"
    },
    {
      "name": "InvalidToken"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "RateLimitExceeded"
    },
    {
      "name": "RecordNotFound"
    },
    {
      "name": "HostUnavailable"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "expires": {
          "description": "Home-world clock minute at which it is discarded if idle.",
          "minimum": 0,
          "type": "integer"
        },
        "session": {
          "description": "`scratch/<name>`.",
          "type": "string"
        },
        "status": {
          "const": "world",
          "description": "world-status verdict.",
          "type": "string"
        }
      },
      "required": [
        "session",
        "status",
        "expires"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "session": {
        "type": "string"
      }
    },
    "required": [
      "session"
    ],
    "type": "params"
  },
  "type": "query"
}