get/gateway/bot

Get gateway information

Retrieves gateway connection information and recommended shard count for establishing WebSocket connections.

get_gateway_bot

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "WebSocket URL to connect to the gateway"
    },
    "shards": {
      "type": "integer",
      "format": "int53",
      "description": "Recommended number of shards to use when connecting"
    },
    "session_start_limit": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "format": "int53",
          "description": "Total number of session starts allowed"
        },
        "remaining": {
          "type": "integer",
          "format": "int53",
          "description": "Remaining number of session starts"
        },
        "reset_after": {
          "type": "integer",
          "format": "int53",
          "description": "Milliseconds until the limit resets"
        },
        "max_concurrency": {
          "type": "integer",
          "format": "int53",
          "description": "Maximum number of concurrent IDENTIFY requests"
        }
      },
      "required": [
        "total",
        "remaining",
        "reset_after",
        "max_concurrency"
      ],
      "description": "Session start rate limit information"
    }
  },
  "required": [
    "url",
    "shards",
    "session_start_limit"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}