Skip to main content

Install

Quick Start

Authentication

For public endpoints, no auth is needed. For user endpoints (api.me.*), pass an access token:
See @urantia/auth for how to obtain an access token via OAuth.

Endpoint Groups

Every method returns typed responses with full autocomplete. For detailed parameter docs, see the API Reference.

Content

Utilities

Feedback

Report a bug, a docs gap, or an idea. No token needed. Added in @urantia/api 0.5.0.
The limit is 5 requests per minute and 10 per 15 minutes per IP address. A 429 throws an error that starts with 429:. See Feedback for every field.

User Data (Authenticated)

Languages

All 197 papers are in Spanish (an AI translation, CC0). Pass lang: 'es' to the paper, paragraph, and table of contents calls. See Translations.
Supported languages: eng (English, default), es (Spanish), fr (French), pt (Portuguese), de (German), ko (Korean). Paragraph text exists in English and Spanish. The language field in the response tells you which language was returned. If a translation is not available, the API falls back to English and returns language: "eng".

Paragraph References

The SDK accepts all three reference formats interchangeably:

Options

Error Handling

All methods throw an Error with the API’s error message on failure: