/kharon/resources

POST /api/kharon/resources

Price: 1 credit

Fetch one item from Kharon's resource library — customer stories, guides, reports, white papers, press releases, product notes and award announcements — by its alias. Returns the body block by block as HTML, the abstract, byline and named authors with their bios and social handles, publication date, reading time, sector and content-type tags, imagery and the page's SEO metadata.

How to use it

Pass the URL segment or the whole /resources/ address; the two intervening path segments are the item's own type and sector, so they need not be supplied. This library is Kharon's own marketing and product material — for its sanctions investigations use /kharon/briefs instead. Join the `html` of the `text` blocks in `body[]` to reconstruct the article. `authors[]` carries the named writers with their bios, while `byline` is the credit line as printed and is often absent.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• alias string required — Resource alias, the last segment of its kharon.com/resources/... address. A full resource URL is accepted and reduced to the alias (examples: "how-a-major-u-s-semiconductor-manufacturer-closed-its-export-controls-blind-spot", "https://www.kharon.com/resources/article/forced-labor/dhs-uflpa-entity-list-additions"; minLength: 1)

Response

• @type string (default: "KharonResource")
• id string nullable
• alias string nullable
• url string nullable
• summary string nullable
• read_time string nullable
• template string nullable
• cta_label string nullable
• published_at string nullable
• created_at string nullable
• updated_at string nullable
• event_date string nullable
• image object nullable
  • @type string (default: "KharonAsset")
  • id string nullable
  • url string nullable
  • alt string nullable
  • width integer nullable
  • height integer nullable
  • mime_type string nullable
• types array (default: [])
  • @type string (default: "KharonCategory")
  • id string nullable
  • alias string nullable
  • duration string nullable
  • image object nullable
    • @type string (default: "KharonAsset")
    • id string nullable
    • url string nullable
    • alt string nullable
    • width integer nullable
    • height integer nullable
    • mime_type string nullable
• sectors array (default: [])
  • @type string (default: "KharonCategory")
  • id string nullable
  • alias string nullable
  • duration string nullable
  • image object nullable
    • @type string (default: "KharonAsset")
    • id string nullable
    • url string nullable
    • alt string nullable
    • width integer nullable
    • height integer nullable
    • mime_type string nullable
• authors array (default: [])
  • @type string (default: "KharonPerson")
  • name string nullable
  • url string nullable
  • role string nullable
  • bio string nullable
  • linkedin string nullable
  • twitter string nullable
  • image object nullable
    • @type string (default: "KharonAsset")
    • id string nullable
    • url string nullable
    • alt string nullable
    • width integer nullable
    • height integer nullable
    • mime_type string nullable
  • positions array (default: [])
    • @type string (default: "KharonPosition")
    • company string nullable
    • role string nullable
• caption string nullable
• byline string nullable
• editorial_updated_at string nullable
• award_title string nullable
• award_provider string nullable
• side_image object nullable
  • @type string (default: "KharonAsset")
  • id string nullable
  • url string nullable
  • alt string nullable
  • width integer nullable
  • height integer nullable
  • mime_type string nullable
• background_image object nullable
  • @type string (default: "KharonAsset")
  • id string nullable
  • url string nullable
  • alt string nullable
  • width integer nullable
  • height integer nullable
  • mime_type string nullable
• body array (default: [])
  • @type string (default: "KharonContentBlock")
  • kind string nullable
  • heading string nullable
  • html string nullable
  • subtext string nullable
  • embed_url string nullable
  • images array (default: [])
    • @type string (default: "KharonAsset")
    • id string nullable
    • url string nullable
    • alt string nullable
    • width integer nullable
    • height integer nullable
    • mime_type string nullable
  • related array (default: [])
    • @type string (default: "KharonRelatedPost")
    • url string nullable
  • sub_blocks array (default: [])
• seo object nullable
  • @type string (default: "KharonSeo")
  • description string nullable
  • keywords string nullable
  • og_title string nullable
  • og_description string nullable
  • canonical_url string nullable
  • noindex boolean nullable
  • nofollow boolean nullable
  • image object nullable
    • @type string (default: "KharonAsset")
    • id string nullable
    • url string nullable
    • alt string nullable
    • width integer nullable
    • height integer nullable
    • mime_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No resource carries that alias Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.