Account & Meta

Key metadata, plan, usage counters, the machine-readable schema, and an unauthenticated sample.

Generated page

This page is generated from the published OpenAPI schema. Do not edit it by hand — run npm run generate:api.

`GET /v1/me`

Account usage

Returns the API key metadata, resolved plan, and current monthly usage.

API key required

Example

bash

curl -sS "https://theneuralledger.com/v1/me" \
  -H "Authorization: Bearer $TNL_API_KEY"

Responses

Status	Meaning
`200`	Successful response.
`401`	Missing or invalid API key.
`429`	Monthly API call limit exceeded.

OpenAPI schema

Machine-readable OpenAPI 3.1 schema for this API surface.

No authentication

Example

bash

curl -sS "https://theneuralledger.com/v1/openapi.json"

Responses

Status	Meaning
`200`	Successful response.
`401`	Missing or invalid API key.
`429`	Monthly API call limit exceeded.

Static developer sample

Returns a small, synthetic, CC0-licensed news dataset for testing integrations without an API key. It never reads production member data.

No authentication

Query parameters

Name	Required	Description	Example
`q`	no	Case-insensitive filter across sample titles, excerpts, categories, and countries. Maximum 200 characters.	`shipping`
`page_size`	no	Stories per page. Maximum 20.	`1`
`cursor`	no	Opaque cursor returned as page.next_cursor for the next page.	`eyJvZmZzZXQiOjF9`

Example

bash

curl -sS "https://theneuralledger.com/v1/sample/news?q=shipping&page_size=1&cursor=eyJvZmZzZXQiOjF9"

Responses

Status	Meaning
`200`	Successful response.
`401`	Missing or invalid API key.
`429`	Monthly API call limit exceeded.