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

main procedure

Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.

Input

Encodingapplication/json

from ref#fork Optional

No description available.

name string Required

No description available.

maxLength: 32 bytesminLength: 1 bytes

Output

Encodingapplication/json

expires integer Required

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

session string Required

`scratch/<name>`.

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://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.",
  "errors": [
    {
      "name": "AuthRequired"
    },
    {
      "name": "InvalidToken"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "RateLimitExceeded"
    },
    {
      "name": "RecordNotFound"
    },
    {
      "name": "HostUnavailable"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "from": {
          "ref": "#fork",
          "type": "ref"
        },
        "name": {
          "maxLength": 32,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    }
  },
  "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"
        }
      },
      "required": [
        "session",
        "expires"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

fork object

No description available.

Properties

height integer Optional

No description available.

minimum: 1

world string Optional

No description available.

View raw schema

{
  "properties": {
    "height": {
      "minimum": 1,
      "type": "integer"
    },
    "world": {
      "type": "string"
    }
  },
  "type": "object"
}