request#

ApiClient.request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)#

Make the HTTP request and return it directly.

Parameters:
methodstr

HTTP method verb.

urlstr

Absolute URL of the target endpoint, including any path and query parameters.

query_paramsstr

Query parameters to pass in the URL.

headersDict

Headers to attach to the request.

post_paramsOptional[Iterable[Tuple[str, Union[str, bytes, Tuple[str, Union[str, bytes], str]]]]]

Request post form parameters for multipart/form-data.

bodySerializedType

Request body.

_preload_contentbool, optional

Whether to return the underlying response without reading or decoding response data. The default is True, in which case the response data is read or decoded. If False, the response data is not read or decoded.

_request_timeoutUnion[float, Tuple[float, float], None]

Timeout setting for the request. If only one number is provided, it is used as a total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. This parameter overrides the session-level timeout setting.