genderapi_capabilities: Read API capabilities and the error catalog

View source: R/account.R

genderapi_capabilitiesR Documentation

Read API capabilities and the error catalog

Description

genderapi_capabilities() sends ⁠GET /⁠ (deployment version, limits and AI availability). genderapi_error_catalog() sends GET /errors, the public catalog of stable error codes, HTTP statuses and recommended actions. Both are unauthenticated: no API key is sent.

Usage

genderapi_capabilities(client = genderapi_client())

genderapi_error_catalog(client = genderapi_client())

Arguments

client

A genderapi_client().

Value

The parsed JSON object as a list of class genderapi_response.

Examples

## Not run: 
genderapi_capabilities()
catalog <- genderapi_error_catalog()

## End(Not run)

genderapi documentation built on Oct. 1, 2026, 5:13 p.m.