Content

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

20

Filter by entry category

Akzeptiert

featureimprovementbugfixdatabreaking

Max. Länge

60

One page of results

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

Integer flag, 1 when the entry is live. The public feed only returns published entries, so this is 1 on every row a consumer sees.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Changelog entry id

Beispiel

039-3d-models-line-art-and-a-phantom-firearm

The response payload

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

Integer flag, 1 when the entry is live. The public feed only returns published entries, so this is 1 on every row a consumer sees.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

Published notices inside their display window, best first: highest priority, then newest.

Row id of the notice. The website keys its dismissal on this, so a new notice is seen even by a reader who dismissed the last one.

Short label shown before the message.

The sentence shown in the banner.

A second line, shown under the highlight where one is set.

How prominently a site notice is shown.

Text of the call to action, or null when the banner has none.

Where the call to action goes.

Higher sorts first. Ties break on newest.

When the notice becomes visible. Null means immediately.

When it stops being shown. This is why notices are rows rather than copy: an end date is the only version of "take this down later" that does not rely on somebody remembering.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

The latest run per language, ordered by language.

Which promise the run is about: sdk for the published packages, api for the cURL commands the reference prints.

The sample's own language. On an SDK run, typescript or python for the published package. On an API run, the tab of the reference it came from: curl, javascript (the TypeScript tab's generated fetch), python (its generated requests), or unity, unreal and godot, which are checked rather than executed.

How the run arrived at its results. executed ran the sample against this API. static could not, and checked the sample against the operation it documents instead: the Unity, Unreal and GDScript samples are fragments meant for a class, an actor or a scene, so running one would mean wrapping it in code the reference does not print.

What was exercised: the release installed from the registry on an SDK run, and the spec version the samples were generated from on an API run. The release rather than the version in our tree, because the badge vouches for what a reader gets today.

The API the run was executed against. Production, so the badge vouches for the live service rather than a preview.

When the run finished, ISO 8601.

The commit of this repository the run was started from, or null where CI did not report one.

The CI run, so the claim can be checked rather than taken.

Examples that ran and returned what the page prints.

Examples that ran and did not. A non-zero count is what takes the badge down.

Write examples, which are never run against production: each would create a real ticket, webhook endpoint or seller offer.

Examples this SDK has no method for. The reference shows no sample for them either.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Narrow to one surface: sdk for the SDK references, api for the reference samples, mcp for the hosted MCP server's tools. Omitted returns every surface.

Akzeptiert

sdkapimcp

Beispiel

api

samples adds sample to each example: what it answered when the run executed it, trimmed for display. Only the MCP surface stores answers today; every example says whether it has one in hasSample either way.

Akzeptiert

samples

The response payload.

The latest run per surface and language, ordered by surface then language.

Which promise the run is about: sdk for the published packages, api for the cURL commands the reference prints.

The sample's own language. On an SDK run, typescript or python for the published package. On an API run, the tab of the reference it came from: curl, javascript (the TypeScript tab's generated fetch), python (its generated requests), or unity, unreal and godot, which are checked rather than executed.

How the run arrived at its results. executed ran the sample against this API. static could not, and checked the sample against the operation it documents instead: the Unity, Unreal and GDScript samples are fragments meant for a class, an actor or a scene, so running one would mean wrapping it in code the reference does not print.

What was exercised: the release installed from the registry on an SDK run, and the spec version the samples were generated from on an API run. The release rather than the version in our tree, because the badge vouches for what a reader gets today.

The API the run was executed against. Production, so the badge vouches for the live service rather than a preview.

When the run finished, ISO 8601.

The commit of this repository the run was started from, or null where CI did not report one.

The CI run, so the claim can be checked rather than taken.

Examples that ran and returned what the page prints.

Examples that ran and did not. A non-zero count is what takes the badge down.

Write examples, which are never run against production: each would create a real ticket, webhook endpoint or seller offer.

Examples this SDK has no method for. The reference shows no sample for them either.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Which environment to report. Production unless asked otherwise; a staging run is never mixed into it.

Akzeptiert

productionstaginglocal

Beispiel

production

Which product the run measured: api for this REST API, mcp for the hosted MCP server. Defaults to api.

Akzeptiert

apimcp

Beispiel

api

The response payload.

The latest run, or null when nothing has been checked on this environment yet.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

20

Filter by post category

Max. Länge

60

Beispiel

guides

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Blog post slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

what-is-firearms-specification-api

The response payload.

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.