Skip to content

Service

Get API metadata

GET /api/meta.json

Returns service metadata including collection counts and capabilities (RFC 8631 service-meta)

Markdown · Authoritative OpenAPI

Request policy

Operation
getMeta
Access
anonymous
Automatic retries
None
Redirects
Returned to the caller without following
Request body limit
No request body
Pagination
No collection iterator

Parameters

No path or query parameters.

Request headers

  • API-Version (optional) — Header-based API version selection. Omit it, send an empty value, or send 1.0.0; surrounding whitespace is ignored.
  • Idempotency-Key (optional) — Accepted for clients that attach a key uniformly. GET, HEAD, and OPTIONS are already safe and intrinsically idempotent, so read responses are not stored in an idempotency replay cache.

Responses

200

API metadata

Response headers
{
  "Content-Usage": {
    "description": "IETF AIPREF usage preferences for this public content",
    "schema": {
      "type": "string",
      "examples": [
        "train-ai=y, search=y"
      ]
    }
  },
  "Content-Signal": {
    "description": "Compatibility AI usage preferences for deployed crawlers",
    "schema": {
      "type": "string",
      "examples": [
        "ai-train=yes, search=yes, ai-input=yes"
      ]
    }
  },
  "API-Version": {
    "description": "Selected public REST contract version",
    "schema": {
      "type": "string",
      "enum": [
        "1.0.0"
      ]
    }
  },
  "RateLimit-Policy": {
    "description": "Public REST quota policy: 1000 Worker requests per 60 seconds for each source and Cloudflare location",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Compatibility form of the current public REST request limit",
    "schema": {
      "type": "integer",
      "enum": [
        1000
      ]
    }
  },
  "ETag": {
    "description": "Entity tag for conditional requests",
    "schema": {
      "type": "string"
    }
  },
  "Last-Modified": {
    "description": "Last modification date (HTTP IMF-fixdate)",
    "schema": {
      "type": "string",
      "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$",
      "examples": [
        "Sun, 06 Sep 2026 17:40:13 GMT"
      ]
    }
  },
  "Cache-Control": {
    "description": "Caching directives",
    "schema": {
      "type": "string"
    }
  }
}

application/json

ServiceMeta

Schema details

name unknown required

version unknown required

lastUpdated string required (date-time)

documentation unknown required

openapi unknown required

sql object required

Schema details

endpoint unknown required

profile unknown required

version unknown required

methods array required

requestMediaType unknown required

responseMediaTypes array required

limits object required

Schema details

maxRequestBytes unknown required

maxTokens unknown required

maxAstDepth unknown required

maxProjectionColumns unknown required

maxPredicates unknown required

maxInItems unknown required

maxPatternLength unknown required

maxRows unknown required

maxColumns unknown required

maxGroupColumns unknown required

maxCost unknown required

maxResponseBytes unknown required

requestsPerMinute unknown required

rateLimitWindowSeconds unknown required

graphql object required

Schema details

endpoint unknown required

schema unknown required

version unknown required

methods array required

limits object required

Schema details

requestBytes unknown required

urlBytes unknown required

operationDefinitions unknown required

rootFields unknown required

depth unknown required

aliases unknown required

fragmentSpreads unknown required

selections unknown required

pageSize unknown required

aggregateNodes unknown required

cost unknown required

responseBytes unknown required

timeoutMs unknown required

skillsIndex unknown required

apiCatalog unknown required

agenticResourceCatalog unknown required

tasteProfile object required

Schema details

endpoint unknown required

mediaType unknown required

discoveryRelation unknown required

musicIntersection object required

Schema details

endpoint unknown required

method unknown required

readOnly unknown required

musicStation object required

Schema details

endpoint unknown required

method unknown required

readOnly unknown required

stateful unknown required

capnweb object required

Schema details

endpoint unknown required

transport unknown required

transports array required

packageVersion unknown required

declaration unknown required

metadata unknown required

stability unknown required

methods string[] required

Schema details

string

Allowed: "service" | "content" | "discovery" | "taste" | "feed"

sessionLimits object required

Schema details

httpBatch object required

Schema details

maxCalls number required

maxWeightedWork number required

maxCapabilities number required

maxReturnedIds number required

maxExportRecords number required

maxResponseBytes number required

maxRequestBytes number required

maxIdleMs unknown required

maxAgeMs unknown required

maxStreams number required

maxStreamChunks number required

maxStreamBytes number required

maxStreamDurationMs number required

websocket object required

Schema details

maxCalls number required

maxWeightedWork number required

maxCapabilities number required

maxReturnedIds number required

maxExportRecords number required

maxResponseBytes number required

maxRequestBytes number required

maxIdleMs number required

maxAgeMs number required

maxStreams number required

maxStreamChunks number required

maxStreamBytes number required

maxStreamDurationMs number required

limits object required

Schema details

maxRequestBytes unknown required

maxBatchOperations unknown required

sessionAdmissionsPerMinute unknown required

sessionAdmissionWindowSeconds unknown required

operationsPerMinute unknown required

Deprecated since 2026-09-03: compatibility alias for sessionAdmissionsPerMinute; it describes session admissions, not RPC operations. Earliest removal is 2026-12-02.

rateLimitWindowSeconds unknown required

Deprecated since 2026-09-03: use sessionAdmissionWindowSeconds. Earliest removal is 2026-12-02.

mcp object required

Schema details

endpoint unknown required

serverCard unknown required

discovery unknown required

protocolVersion unknown required

collections CollectionsMetadata required

Schema details

activities object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "year" | "sportType" | "q"

sortable string[] required

Schema details

string

Allowed: "startDate" | "distanceMeters" | "movingTimeSeconds" | "title"

movies object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "type" | "year" | "genre" | "director" | "actor" | "q"

sortable string[] required

Schema details

string

Allowed: "releaseDate" | "year" | "addedAt" | "title"

places object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "city" | "country" | "category" | "neighborhood" | "q"

sortable string[] required

Schema details

string

Allowed: "name"

events object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "type" | "city" | "year" | "q"

sortable string[] required

Schema details

string

Allowed: "startsAt" | "addedAt" | "title"

sports object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "team" | "sport" | "league" | "year" | "city" | "venue" | "experience" | "experienceStatus" | "q"

sortable string[] required

Schema details

string

Allowed: "date" | "title" | "sport" | "league"

music object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "genre" | "type" | "q"

sortable string[] required

Schema details

string

Allowed: "addedAt" | "releaseDate" | "title" | "relevance"

concerts object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "year" | "artist" | "venue" | "city" | "q"

sortable string[] required

Schema details

string

Allowed: "startDate" | "addedAt" | "title"

videos object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "category" | "q"

sortable string[] required

Schema details

string

Allowed: "addedAt" | "releaseDate" | "title"

podcasts object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "show" | "q"

sortable string[] required

Schema details

string

Allowed: "addedAt" | "releaseDate"

tweets object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "author" | "q"

sortable string[] required

Schema details

string

Allowed: "createdAt" | "addedAt"

stars object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "q" | "category" | "language"

sortable string[] required

Schema details

string

Allowed: "starredAt" | "fullName" | "stargazersCount"

code object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "kind" | "repo" | "year" | "q"

sortable string[] required

Schema details

string

Allowed: "occurredAt" | "addedAt" | "score" | "title"

photos object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "year" | "month"

sortable string[] required

Schema details

string

Allowed: "date"

books object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "author" | "q"

sortable string[] required

Schema details

string

Allowed: "dateRead" | "purchasedAt" | "addedAt" | "year" | "rating" | "title" | "author"

work object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "year" | "kind" | "company"

sortable string[] required

Schema details

string

Allowed: "date" | "title" | "company" | "id"

reading object required

Schema details

count number required

endpoint unknown required

filters string[] required

Schema details

string

Allowed: "q" | "domain"

sortable string[] required

Schema details

string

Allowed: "publishedAt" | "addedAt" | "title" | "domain"

304

Not Modified

400

Unsupported API version

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

412

Precondition Failed

429

Public REST request limit exceeded

Response headers
{
  "Retry-After": {
    "description": "Seconds before the request should be retried",
    "schema": {
      "type": "integer",
      "enum": [
        60
      ]
    }
  },
  "RateLimit": {
    "description": "Current quota state for the exhausted public-rest policy",
    "schema": {
      "type": "string"
    }
  },
  "Content-Usage": {
    "description": "IETF AIPREF usage preferences for this public content",
    "schema": {
      "type": "string",
      "examples": [
        "train-ai=y, search=y"
      ]
    }
  },
  "Content-Signal": {
    "description": "Compatibility AI usage preferences for deployed crawlers",
    "schema": {
      "type": "string",
      "examples": [
        "ai-train=yes, search=yes, ai-input=yes"
      ]
    }
  },
  "API-Version": {
    "description": "Selected public REST contract version",
    "schema": {
      "type": "string",
      "enum": [
        "1.0.0"
      ]
    }
  },
  "RateLimit-Policy": {
    "description": "Public REST quota policy: 1000 Worker requests per 60 seconds for each source and Cloudflare location",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Compatibility form of the current public REST request limit",
    "schema": {
      "type": "integer",
      "enum": [
        1000
      ]
    }
  }
}

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

Examples

Examples use synthetic fixture values. Replace fixture identifiers with public IDs returned by the service. Request bodies and precise locations are transient; keep them out of logs.

curl

curl --fail-with-body --max-time 30 --max-filesize 16777216 --request GET 'https://irvinebroque.com/api/meta.json' --header 'Accept: application/json'

TypeScript

import { PublicApi } from '@irvinebroque/public-api';
const api = new PublicApi();
const result = await api.service.meta({});
console.log(result.status, result.headers.get('content-type')); // Keep transient capabilities in memory.

CLI

irvinebroque service meta

The SDK preserves status, headers, and the server envelope. A 304 has no fresh body. Errors retain structured problem details; ordinary error messages omit response details. Responses are limited to 16 MiB and requests time out after 30 seconds by default.