Skip to content
To Legacy DocumentationTo Comet website
Doc version: 2.3.30

call_api

Call a Comet REST API endpoint

Description

This function is only meant for advanced users. If you would like to call any arbitrary Comet API endpoint that isn't natively supported by cometr , you can use this function.

Usage

call_api(
  endpoint,
  method = c("GET", "POST"),
  params = list(),
  response_json = TRUE,
  api_key = NULL
)

Arguments

ArgumentDescription
endpointThe REST API endpoint.
methodThe HTTP method to use, either "GET" or "POST".
paramsA list of parameters. For GET endpoints, the parameters are appended to the URL; for POST endpoints, the parameters are sent in the body of the request.
response_jsonIf TRUE , try to parse the response as JSON. If FALSE , return the response as raw data (useful when the response is a file).
api_keyComet API key (can also be specified using the COMET_API_KEY parameter as an environment variable or in a comet config file).

Value

The parsed response

Sep. 19, 2023