Endpoint · Articles

Get an article

One source article with its annotations, linked events and organisations.

GET/v1/articles/{articleReference}

Authentication

Bearer token in the Authorization header. The token reaches what your plan covers. Getting a token.

Parameters

path parameters

articleReferenceuuid·pathrequired
The article's reference.

Response

success holds the object below.

  • referenceuuid
  • titlestring
  • urlstring | null
  • published_atdatetime
  • contentstringThe article text, where its licence allows.
  • offsets_unitstringAlways utf16.
  • annotationsarrayWhere the licence allows.Show 8 fields
    • referenceuuidThe annotation's reference.
    • typestringspeech, feedback, recommendation or review. See statements.
    • summarystringA one-line summary.
    • textstring | nullThe verbatim passage, where the article's licence allows it.
    • startintegerStart offset into the article content, in UTF-16 code units.
    • endintegerEnd offset, in UTF-16 code units.
    • speakerobject{ kind, name, role, organisation_name, profile_reference }. kind is person or body.
    • subjectobject{ name, role, organisation_name, profile_reference }.
  • eventsarray{ reference, type }.
  • organisationsarray{ reference, name }.

Examples

Set CHIKARA_API_TOKEN and each sample runs as written. Example records are invented.

curl -sS "https://api.chikaraintel.com/v1/articles/8e1f2a3b-c5d6-4e7f-8a9b-c0d1e2f3a4e1" \
  -H "Authorization: Bearer $CHIKARA_API_TOKEN" \
  -H "Accept: application/json"

See pagination and errors.

Related