request - Byte Documentation

request(options: HttpRequest): HttpResponse | string

Aliases

http_request
http.request

Arguments

HttpRequest

required

An HttpRequest table containing Url, Method, Headers, Cookies, and Body. See Related types.

Returns

HttpResponse | string

An HttpResponse table, or a diagnostic string on transport failure.

Validation failures raise; transport failures may return a string. Non-2xx HTTP responses still return a table. See the request/response schema below. Related types: HTTP types & behavior.

Example

local ok, response = pcall(request, {Url = "https://example.com", Method = "GET"})
if not ok or type(response) ~= "table" then
    warn(response)
elseif response.Success then
    print(response.StatusCode, response.Body:sub(1, 80))
else
    warn(response.StatusCode, response.StatusMessage)
end

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example