One article by its id, following corpus migrations

With after (or limit) and no id: the walk over every General article (schema Walk).

get/articles

Request

  • Base URL: https://www.edgechat.ai/api/v1
  • URL: https://www.edgechat.ai/api/v1/articles
  • Auth: none declared

Query parameters

idstring

An article id. A migrated or merged id responds with a 308 redirect to its canonical survivor. One of id, ids, name, or after/limit (the walk).

sectionstring

One section, by its heading or a word of it; lead is the opening.

outline'1'

Adds outline: every heading with its size in tokens.

max_tokensinteger

Cut the text to about this many tokens at a section boundary; adds next_cursor.

cursorstring

A next_cursor from an earlier answer with the same max_tokens.

length'snippet' | 'lead' | 'full'

snippet or lead for a short text; full (default) for the whole article.

format'text' | 'html' | 'jsonld' | 'turtle' | 'tables'

The answer as plain text, HTML, JSON-LD, or Turtle; tables adds the tables as JSON and CSV.

chunks'1'

The text as paragraphs with stable ids, in chunks.

qstring

Words to find inside the article: passages, best first.

kinteger

How many passages q returns.

quotestring

A sentence of the article or a chunk id: adds cite_url, the page opened at it.

cite'csl' | 'bibtex' | 'ris' | 'apa' | 'mla' | 'chicago' | 'harvard'

Adds cite: a reference in this format.

idsstring

Up to 10 articles by address, id, or name, comma-separated; each counts as one request. Returns articles and missing.

namestring

The article by any name: a title, an alias, or a whole edgechat.ai address.

afterstring

An article id: the walk continues after it. Empty: from the start.

limitinteger

Articles in one page of the walk, 1 to 1000 (default 100).

suggest'1'

1 = when the address answers nothing, read it as a name and, if still nothing, name the nearest articles in did_you_mean. Without it, a lowercase hyphenated address (a slug) that no article holds is a 404 unless it is an ep… id or a title's own spelling; an address with capitals, spaces, or underscores (Albert_Einstein, Coastal Radio) is read as a name: an exact title opens its article, and otherwise the best search match is returned with resolved_by: search.

next'1' | 'true'

1 = add up to 5 articles to read next (next).

links'in' | 'out' | 'both'

Add the articles linking here (in: the first 30, links_in), the links it makes (out, links_out), or both.

citations'true' | 'false'

false = [n] markers in place of the inline source links, in markdown, chunks, and passages; the numbered reference list stays.

fieldsstring

Comma-separated keys: each result (or the answer, when it has no results) keeps only these.

Response

The article

GetArticlesResponse required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.