Profile: note

Profile schema

The note profile is meant to be used within an asset that lives in the asset array (See the publishable profile documentation). It represents an additoin to a story, podcast episode, or other published page that describes or clarifies the page’s content, but is distinct from a Correction. It is textual in nature and does not provide any links.

This profile works and is a requirement for the has-notes profile.

Structure

The newscast profile specifies the following attribute:

Name Type Required? Explanation
text string Yes The text of the given note about the document the asset lives within.
dateTime date-time string Yes Notes need to be timestamped as to when they were added to the piece of content. In this case the content is the CDS document that the note asset is included within. Use the RFC3339 format set in UTC time (ex: 2021-11-04T08:49:00Z) (ex: 2021-11-04T08:49:00Z). See our tutorial on UTC time for more help.
title string No An optional title for the note e.g. “From the Editor’s Desk”. Meant to be a title that is rendered along with the note asset. 
{
    "id": "unique-note-id",
    "profiles": [
        {
            "href": "/v1/profiles/note",
            "rels": ["type"]
        },
        {
            "href": "/v1/profiles/document"
        }
    ],
    "title": "Optional note title",
    "text": "A note about this story",
    "dateTime": "2025-11-12T00:00:00Z"
}

Example JSON within a full document

Note that this example uses the separate but required has-notes profile.

{
    "id": "g-s1-test-story-with-notes",
    "title": "Test story with notes!",
    "teaser": "A lightweight JSON document showcasing the new has-notes profile",
    "profiles": [
        {
            "href": "/v1/profiles/story",
            "rels": ["type"]
        },
        {
            "href": "/v1/profiles/publishable",
            "rels": ["interface"]
        },
        {
            "href": "/v1/profiles/document"
        },
        {
            "href": "/v1/profiles/has-notes"
        }
    ],
    "authorizedOrgServiceIds": ["s1"],
    "owners": [
        {
            "href": "https://organization.api.npr.org/v4/services/s1"
        }
    ],
    "brandings": [
        {
            "href": "https://organization.api.npr.org/v4/services/s1"
        }
    ],
    "publishDateTime": "2025-01-01T00:59:00-05:00",
    "notes": [
        {
            "href": "#/assets/g-s1-test-story-with-notes-note-001",
            "rels": ["editorial"]
        }
    ],
    "assets": {
        "g-s1-test-story-with-notes-note-001": {
            "profiles": [
                {
                    "href": "/v1/profiles/document"
                },
                {
                    "href": "/v1/profiles/note"
                }
            ],
            "id": "g-s1-test-story-with-notes-note-001",
            "title": "From the Editors Desk",
            "text": "A note on this story, from the Editor",
            "datetime": "2025-01-01T00:59:00-05:00"
        }
    }
}

© 2025 npr