### Run Citoid Service (Bash)

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Commands to start the Citoid service using default or custom configurations, and to run its test suites. Ensure Node.js and npm are installed.

```bash
# Start service with dev config
npm ci
node server.js   # reads config.dev.yaml by default
```

```bash
# Start service with prod config
SERVICE_CONFIG=config.prod.yaml node server.js
```

```bash
# Run tests (no live Zotero required)
npm test
```

```bash
# Run full test suite including Zotero integration tests
npm run test:zotero
```

--------------------------------

### Service information

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Returns metadata about the running service instance including its name, description, version, and home URL.

```APIDOC
## GET `/_info` — Service information

### Description
Retrieves metadata about the running Citoid service instance.

### Method
GET

### Endpoint
`/_info`

### Response
#### Success Response (200 OK)
- **Content-Type**: `application/json`
- **Body**: JSON object containing service details.

#### Response Example
```json
{
  "name": "citoid",
  "description": "Converts search terms such as URL or DOI into citations.",
  "version": "3.0.0",
  "home": "https://www.mediawiki.org/wiki/Citoid"
}
```
```

--------------------------------

### Access API Specification (Swagger UI)

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

The root endpoint provides access to the OpenAPI 3.0 specification. Append '?doc' to view the interactive Swagger UI documentation.

```bash
curl "http://localhost:1970/?spec=true"
```

```bash
open "http://localhost:1970/?doc#!/Citations/get_api"
```

--------------------------------

### API specification (Swagger UI)

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

The root endpoint serves the OpenAPI 3.0 spec or the Swagger UI documentation page. Append `?doc` to open the interactive docs.

```APIDOC
## GET `/` — API specification (Swagger UI)

### Description
Serves the OpenAPI 3.0 specification or the interactive Swagger UI documentation.

### Method
GET

### Endpoint
`/`

### Query Parameters
- **spec** (boolean) - Optional - If `true`, returns the raw OpenAPI spec as JSON.
- **doc** (boolean) - Optional - If `true` (or if the parameter is present without a value), opens the interactive Swagger UI.

### Request Example
```bash
# Retrieve the raw OpenAPI spec as JSON
curl "http://localhost:1970/?spec=true"

# Open interactive Swagger UI in a browser
open "http://localhost:1970/?doc#!/Citations/get_api"
```
```

--------------------------------

### Configure Citoid Service (YAML)

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

This configuration file controls the runtime behavior of the Citoid service. Key options include Zotero integration, Wayback Machine fallback, PubMed enrichment, timeout settings, and polite-pool email for CrossRef/PubMed.

```yaml
services:
  - name: citoid
    module: ./app.js
    conf:
      port: 1970
      cors: "*"

      # External integrations
      zotero: true            # Enable Zotero translation-server
      zoteroInterface: 127.0.0.1
      zoteroPort: 1969

      wayback: false          # Enable Wayback Machine fallback for failed URLs
      pubmed: true            # Wait for PubMed ID enrichment (PMID/PMCID/DOI)

      # CrossRef / PubMed polite-pool: supply email for better rate limits
      mailto: your@email.org

      # Race CrossRef vs URL resolution after this many ms (false = no timeout)
      timeout: 10000          # ms

      maxRedirects: 5
      allowPrivateAddresses: false

      # User agent sent to external services
      user_agent: "citoid/3.0.0"
```

--------------------------------

### Exporter.convertToWikibase

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Converts internal Zotero-format citation objects into Wikibase JSON format with identifiers.

```APIDOC
## `Exporter.convertToWikibase(citation, request)`

### Description
Converts internal Zotero-format citation objects into Wikibase JSON format, including a nested object for identifiers. This is one of the supported output formats by the Exporter class.

### Method
Exporter method

### Parameters
- **citation** (object) - The citation object in Zotero format.
- **request** (object) - The request object.

### Response Example (Output Format)
```json
{
  "itemType": "journalArticle",
  "title": "...",
  "author": [["First", "Last"]],
  "identifiers": {
    "doi": "10.x/y",
    "pmid": "123",
    "pmcid": "PMC456",
    "isbn10": ["..."],
    "isbn13": ["..."],
    "url": "https://..."
  }
}
```
```

--------------------------------

### Exporter.convertToBaseFields

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Converts internal Zotero-format citation objects into mediawiki-basefields JSON format.

```APIDOC
## `Exporter.convertToBaseFields(citation, request)`

### Description
Converts internal Zotero-format citation objects into mediawiki-basefields JSON format. This is one of the supported output formats by the Exporter class.

### Method
Exporter method

### Parameters
- **citation** (object) - The citation object in Zotero format.
- **request** (object) - The request object.

### Response Example (Output Format)
```json
{
  "itemType": "journalArticle",
  "title": "...",
  "author": [["First", "Last"]],
  "publicationTitle": "...",
  "date": "...",
  "DOI": "..."
}
```
```

--------------------------------

### Retrieve Service Information

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Fetch metadata about the running Citoid service instance, including its name, version, and home URL. This endpoint is useful for monitoring and understanding the service.

```bash
curl "http://localhost:1970/_info"
```

```json
{
  "name": "citoid",
  "description": "Converts search terms such as URL or DOI into citations.",
  "version": "3.0.0",
  "home": "https://www.mediawiki.org/wiki/Citoid"
}
```

--------------------------------

### Exporter.convertToMediawiki

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Converts internal Zotero-format citation objects into mediawiki JSON format.

```APIDOC
## `Exporter.convertToMediawiki(citation, request)`

### Description
Converts internal Zotero-format citation objects into mediawiki JSON format. This is one of the supported output formats by the Exporter class.

### Method
Exporter method

### Parameters
- **citation** (object) - The citation object in Zotero format.
- **request** (object) - The request object.

### Response Example (Output Format)
```json
{
  "itemType": "journalArticle",
  "title": "...",
  "author": [["First", "Last"]],
  "publicationTitle": "...",
  "date": "...",
  "DOI": "..."
}
```
```

--------------------------------

### CitoidService.requestFromSearch

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Performs a free-text citation search against the CrossRef REST API, returning up to 2 results and mapping metadata to Zotero item types.

```APIDOC
## `CitoidService.requestFromSearch(citation, cr)` — Open-text search

### Description
Performs a free-text citation search against the CrossRef REST API (up to 2 results), mapping returned metadata to Zotero item types via the CrossRef type translator.

### Method
GET

### Endpoint
`/mediawiki/{article_title}`

### Parameters
#### Path Parameters
- **article_title** (string) - Required - The URL-encoded article title text to search for.

### Request Example
```bash
# Search by article title text (URL-encoded)
curl "http://localhost:1970/mediawiki/The%20ENCODE%20Project%3A%20ENCyclopedia%20Of%20DNA%20Elements"
```

### Response Example (Success)
```json
[
  {
    "itemType": "journalArticle",
    "title": "...",
    "DOI": "10.1038/..",
    "author": [["First", "Last"]],
    "source": ["Crossref"]
  },
  {
    "itemType": "journalArticle",
    ...
  }
]
```
```

--------------------------------

### Free-text Citation Search using CrossRef API

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Performs a free-text citation search against the CrossRef REST API, returning up to 2 results. Metadata is mapped to Zotero item types via the CrossRef type translator. The search query must be URL-encoded.

```bash
# Search by article title text (URL-encoded)
curl "http://localhost:1970/mediawiki/The%20ENCODE%20Project%3A%20ENCyclopedia%20Of%20DNA%20Elements"
```

--------------------------------

### Fetch Citation Data via REST API

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Use the primary endpoint to retrieve citation data by specifying the desired format and a URL-encoded identifier. Supports various identifier types and output formats. Rate limit is 1 request per second.

```bash
curl "http://localhost:1970/mediawiki/https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FMain_Page"
```

```json
[{
  "itemType": "webpage",
  "title": "Wikipedia, the free encyclopedia",
  "url": "https://en.wikipedia.org/wiki/Main_Page",
  "websiteTitle": "Wikipedia",
  "accessDate": "2024-01-15",
  "source": ["Zotero"]
}]
```

```bash
curl "http://localhost:1970/zotero/10.1038%2Fnature09210"
```

```json
[{
  "itemType": "journalArticle",
  "title": "An integrated encyclopedia of DNA elements in the human genome",
  "DOI": "10.1038/nature09210",
  "publicationTitle": "Nature",
  "volume": "489",
  "pages": "57–74",
  "date": "2012-09-05",
  "source": ["Zotero"]
}]
```

```bash
curl "http://localhost:1970/bibtex/10.1038%2Fnature09210"
```

```bibtex
# @article{...}
```

```bash
curl "http://localhost:1970/mediawiki-basefields/20478883"
```

```json
[{
  "itemType": "journalArticle",
  "title": "...",
  "publicationTitle": "...",
  "PMID": "20478883",
  "PMCID": "2880113",
  "source": ["PubMed", "Zotero"]
}]
```

```bash
curl "http://localhost:1970/mediawiki/9780810935310"
```

```bash
curl "http://localhost:1970/wikibase/Q180445"
```

```bash
curl -H "Accept-Language: fr" \
  "http://localhost:1970/mediawiki/https%3A%2F%2Ffr.wikipedia.org%2Fwiki%2FWikip%C3%A9dia%3AAccueil_principal"
```

```json
{
  "type": "https://mediawiki.org/wiki/HyperSwitch/errors/not_found",
  "title": "Not found",
  "detail": "Unable to resolve DOI ...",
  "uri": "/mediawiki/..."
}
```

--------------------------------

### Exporter.convertToBibtex

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Converts internal Zotero-format citation objects into BibTeX string format.

```APIDOC
## `Exporter.convertToBibtex(citation, request)`

### Description
Converts internal Zotero-format citation objects into a BibTeX string. This requires Zotero to be available.

### Method
Exporter method

### Parameters
- **citation** (object) - The citation object in Zotero format.
- **request** (object) - The request object.

### Response Example (Output Format)
```bibtex
@article{Doe2023,
  author  = {Doe, Jane},
  title   = {...},
  journal = {...},
  year    = {2023},
  doi     = {10.x/y}
}
```
```

--------------------------------

### Exporter.convertToZotero

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Converts internal Zotero-format citation objects into raw Zotero JSON format.

```APIDOC
## `Exporter.convertToZotero(citation, request)`

### Description
Converts internal Zotero-format citation objects into raw Zotero JSON format. This is one of the supported output formats by the Exporter class.

### Method
Exporter method

### Parameters
- **citation** (object) - The citation object in Zotero format.
- **request** (object) - The request object.

### Response Example (Output Format)
```json
{
  "itemType": "journalArticle",
  "title": "...",
  "creators": [
    { "creatorType": "author", "firstName": "Jane", "lastName": "Doe" }
  ],
  "publicationTitle": "...",
  "date": "...",
  "DOI": "..."
}
```
```

--------------------------------

### Direct API Call using PubMed URL

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Use this endpoint to retrieve citation metadata directly by providing a PubMed URL. The URL must be URL-encoded.

```bash
curl "http://localhost:1970/mediawiki/https%3A%2F%2Fpubmed.ncbi.nlm.nih.gov%2F20478883%2F"
```

--------------------------------

### fixISBN utility

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Standalone utility function to fix ISBN strings by adding hyphens and converting them to an array.

```APIDOC
## `fixISBN(isbnObject)`

### Description
Fixes ISBN strings by adding hyphens for readability and converts the ISBN to an array if it's a single string.

### Method
Utility function

### Parameters
- **isbnObject** (object) - An object containing the ISBN string, e.g., `{ ISBN: '9780810935310' }`.

### Response Example (Output)
```json
{ "ISBN": ["978-0-8109-3531-0"] }
```
```

--------------------------------

### Direct API Call using PMCID

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Use this endpoint to retrieve citation metadata directly using a PubMed Central ID.

```bash
curl "http://localhost:1970/mediawiki/PMC2880113"
```

--------------------------------

### Exporter Class for Format Conversion and Utilities

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

The Exporter class converts internal Zotero-format citation objects into supported output formats and handles identifier enrichment. Standalone utilities are available for fixing and normalizing dates, ISBNs, and validating ISBN strings.

```javascript
const { Exporter, fixDate, fixISBN, validateISBN } = require('./lib/Exporter');
```

```javascript
// Supported format functions (selected by citation.format):
// exporter.convertToMediawiki(citation, request)      → mediawiki JSON
// exporter.convertToBaseFields(citation, request)     → mediawiki-basefields JSON
// exporter.convertToZotero(citation, request)         → raw Zotero JSON
// exporter.convertToBibtex(citation, request)         → BibTeX string (needs Zotero)
// exporter.convertToWikibase(citation, request)       → Wikibase JSON with identifiers{}
```

```javascript
// Standalone utility: fix and normalize dates
fixDate({ date: '2010, ©2009' });    // → { date: '2009' }
fixDate({ date: '2012 Dec-Jan' });   // → { date: '2012-12' }
fixDate({ date: '1660320653' });     // → { date: '2022-08-12' } (unix timestamp)
```

```javascript
// Standalone utility: fix ISBNs (add hyphens, convert to array)
fixISBN({ ISBN: '9780810935310' });
// → { ISBN: ['978-0-8109-3531-0'] }
```

```javascript
// Standalone utility: validate ISBN string
validateISBN('978-0-8109-3531-0');  // → '9780810935310'
validateISBN('not-an-isbn');        // → false
```

```javascript
// Mediawiki format: creators converted from Zotero to 2D array
// Input:  { creators: [{ creatorType: 'author', firstName: 'Jane', lastName: 'Doe' }] }
// Output: { author: [['Jane', 'Doe']] }  (creators key removed)
```

```javascript
// Wikibase format: identifiers moved into nested object
// Output: { identifiers: { doi: '10.x/y', pmid: '123', pmcid: 'PMC456',
//                          isbn10: ['...'], isbn13: ['...'], url: 'https://...' } }
```

--------------------------------

### Retrieve citation data

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

The primary endpoint accepts a citation format and a URL-encoded identifier (URL, DOI, ISBN, PMID, PMCID, or QID). It auto-detects the identifier type, fetches metadata from all relevant sources, and returns a structured citation object or BibTeX string. The rate limit for automated requests is 1 request per second.

```APIDOC
## GET `/{format}/{query}` — Retrieve citation data

### Description
Retrieves structured citation data for a given identifier and format. Supports URLs, DOIs, ISBNs, PMIDs, PMCIDs, and QIDs. The rate limit is 1 request per second.

### Method
GET

### Endpoint
`/{format}/{query}`

### Parameters
#### Path Parameters
- **format** (string) - Required - The desired output format (e.g., `mediawiki`, `zotero`, `bibtex`, `mediawiki-basefields`, `wikibase`).
- **query** (string) - Required - The URL-encoded citation identifier (e.g., URL, DOI, ISBN, PMID, PMCID, QID).

### Request Example
```bash
# Fetch citation for a URL in mediawiki format
curl "http://localhost:1970/mediawiki/https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FMain_Page"

# Fetch citation for a DOI in zotero format
curl "http://localhost:1970/zotero/10.1038%2Fnature09210"

# Fetch citation for a DOI in bibtex format
curl "http://localhost:1970/bibtex/10.1038%2Fnature09210"

# Fetch citation for a PMID in mediawiki-basefields format
curl "http://localhost:1970/mediawiki-basefields/20478883"

# Fetch by ISBN in mediawiki format (requires Zotero enabled)
curl "http://localhost:1970/mediawiki/9780810935310"

# Fetch citation for a Wikidata QID in wikibase format
curl "http://localhost:1970/wikibase/Q180445"

# Fetch using Accept-Language header for localized content
curl -H "Accept-Language: fr" \
  "http://localhost:1970/mediawiki/https%3A%2F%2Ffr.wikipedia.org%2Fwiki%2FWikip%C3%A9dia%3AAccueil_principal"
```

### Response
#### Success Response (200 OK)
- **Content-Type**: `application/json` for most formats, `application/x-bibtex` for `bibtex`.
- The response is a JSON array of citation objects, or a BibTeX string.

#### Response Example (application/json)
```json
[
  {
    "itemType": "webpage",
    "title": "Wikipedia, the free encyclopedia",
    "url": "https://en.wikipedia.org/wiki/Main_Page",
    "websiteTitle": "Wikipedia",
    "accessDate": "2024-01-15",
    "source": ["Zotero"]
  }
]
```

#### Response Example (application/x-bibtex)
```bibtex
@article{...
```

#### Error Response (404 Not Found)
- **Content-Type**: `application/problem+json`
```json
{
  "type": "https://mediawiki.org/wiki/HyperSwitch/errors/not_found",
  "title": "Not found",
  "detail": "Unable to resolve DOI ...",
  "uri": "/mediawiki/..."
}
```
```

--------------------------------

### Native HTML Scraper for Citation Metadata

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Fetches a URL directly, decodes the response body, and extracts citation metadata using multiple translator passes. Falls back to schema.org for title extraction and integrates CrossRef lookup when a DOI is found. This scraper is triggered when Zotero is disabled or unavailable, or for archive.org URLs.

```javascript
// Triggered when Zotero is disabled or unavailable, or for archive.org URLs.
// The scraper runs these translation passes in order:
//   1. bePress.js  — Highwire Press & bePress metadata tags
//   2. openGraph.js — og:title, og:type, og:description, og:site_name
//   3. dublinCore.js — DC.title, DC.creator, DC.date, DC.identifier
//   4. general.js  — <title>, <meta name="author">, <link rel="canonical">
//   5. fallback()  — schema.org itemprop="headline", hostname as websiteTitle

// itemType detection priority:
//   bePress/Highwire keys → OpenGraph og:type → Dublin Core type → default 'webpage'
```

```javascript
// Example: scraping a news article URL
// GET /mediawiki/https%3A%2F%2Fwww.bbc.com%2Fnews%2Fscience-environment-12345678
// → { itemType: 'webpage', title: 'Article title', websiteTitle: 'www.bbc.com',
//     url: 'https://www.bbc.com/news/...', accessDate: '2024-01-15',
//     source: ['citoid'] }
```

```javascript
// Wayback Machine fallback (when conf.wayback: true):
// If the direct URL fetch fails, waybackService.availability(url) is queried.
// If an archived version exists, scrape() is called again with the archive URL.
// Output adds: { archiveUrl: 'https://web.archive.org/web/20240115.../...', archiveDate: '2024-01-15' }
```

--------------------------------

### Scraper.scrape

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Fetches a URL directly, decodes the response, and extracts citation metadata using various translation passes.

```APIDOC
## `Scraper.scrape(citation, cr, uri?)` — Native HTML scraper

### Description
Fetches a URL directly, decodes the response body using the correct charset, loads it into Cheerio, and extracts citation metadata using multiple translator passes (Highwire Press / bePress, OpenGraph, Dublin Core, general HTML). Falls back to schema.org `headline` itemprop for title extraction. Integrates CrossRef lookup when a DOI is found in page metadata.

This scraper is triggered when Zotero is disabled or unavailable, or for archive.org URLs.

### Method
Scraper method

### Parameters
- **citation** (object) - Citation object.
- **cr** (object) - CrossRef object.
- **uri** (string, optional) - The URI to scrape.

### Request Example
```bash
# Example: scraping a news article URL
GET /mediawiki/https%3A%2F%2Fwww.bbc.com%2Fnews%2Fscience-environment-12345678
```

### Response Example (Success)
```json
{
  "itemType": "webpage",
  "title": "Article title",
  "websiteTitle": "www.bbc.com",
  "url": "https://www.bbc.com/news/...".
  "accessDate": "2024-01-15",
  "source": ["citoid"]
}
```

### Response Example (Wayback Machine Fallback)
```json
{
  "itemType": "webpage",
  "title": "Article title",
  "websiteTitle": "www.bbc.com",
  "url": "https://www.bbc.com/news/...".
  "accessDate": "2024-01-15",
  "source": ["citoid"],
  "archiveUrl": "https://web.archive.org/web/20240115.../...".
  "archiveDate": "2024-01-15"
}
```
```

--------------------------------

### validateISBN utility

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Standalone utility function to validate an ISBN string.

```APIDOC
## `validateISBN(isbnString)`

### Description
Validates if a given string is a valid ISBN.

### Method
Utility function

### Parameters
- **isbnString** (string) - The ISBN string to validate.

### Response Example (Output)
```json
"9780810935310" // Returns the cleaned ISBN if valid
false // Returns false if invalid
```
```

--------------------------------

### fixDate utility

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Standalone utility function to fix and normalize date strings.

```APIDOC
## `fixDate(dateObject)`

### Description
Fixes and normalizes date strings, handling various formats including year-only, year ranges, and Unix timestamps.

### Method
Utility function

### Parameters
- **dateObject** (object) - An object containing the date string, e.g., `{ date: '2010, ©2009' }`.

### Response Example (Output)
```json
{ "date": "2009" } // For input '2010, ©2009'
{ "date": "2012-12" } // For input '2012 Dec-Jan'
{ "date": "2022-08-12" } // For input '1660320653' (unix timestamp)
```
```

--------------------------------

### Resolve URL Citation

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Resolves a URL to citation data by following redirects, checking content-type, and querying Zotero's web translator or falling back to a native scraper. Optionally uses the Wayback Machine on failure.

```javascript
// Internally used; the URL must already be set on the Citation object.
// Configuration options that affect behavior (config.dev.yaml):
// conf:
//   zotero: true          # Use Zotero translation-server first
//   wayback: false        # Fall back to archive.org on failure
//   maxRedirects: 5       # Max redirect hops in unshorten
//   timeout: false        # ms; if set, race CrossRef vs URL resolution

// Flow for a standard URL:
// 1. unshorten(url) → follows redirects, gets resolvedUrl + response headers
// 2. invalidContentType() → reject if not text/html, text/plain, application/xhtml+xml
// 3. zoteroService.zoteroWebRequest() → try Zotero first
// 4. On Zotero failure → scraper.scrape(citation, cr)
// 5. On scrape failure → rejectWithError / try requestFromDOI if DOI present
// 6. If wayback enabled and URL fails → waybackService.availability(url) → scrape archive
```

--------------------------------

### Direct API call using a PubMed URL

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Retrieve citation metadata directly using a PubMed URL.

```APIDOC
## Direct API call using a PubMed URL
GET /mediawiki/{pubmed_url}

### Description
Retrieves citation metadata using a provided PubMed URL. The URL must be URL-encoded.

### Endpoint
`/mediawiki/{pubmed_url}`

### Example
```bash
curl "http://localhost:1970/mediawiki/https%3A%2F%2Fpubmed.ncbi.nlm.nih.gov%2F20478883%2F"
```

### Response Example (Success)
```json
{
  "itemType": "journalArticle",
  "PMID": "20478883",
  "PMCID": "2880113",
  "DOI": "10.1038/..",
  "source": ["PubMed", "Zotero"]
}
```
```

--------------------------------

### Resolve DOI Citation

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Resolves a DOI to citation metadata by running Zotero search, CrossRef REST API lookup, and canonical URL resolution concurrently. Returns the first successful result.

```javascript
// Triggered when input matches /\b10\.[0-9]{3,5}(?:[.][0-9]+)*\/.*/
// Internal resolution cascade:
// 1. zoteroService.zoteroSearchRequest(doi) — if zotero enabled
// 2. On Zotero failure, races:
//    a. crossRefService.doi(doi) → metadata from https://api.crossref.org/works/<doi>
//    b. unshorten("https://doi.org/<doi>") → requestFromURL(resolvedUrl)
//    c. Optional: timeout rejection after conf.timeout ms
// 3. BBPromise.some([crossref, fromURL, timeout], 2) picks two fastest successful resolvers

// Example CrossRef response fields used:
// { type: 'journal-article', title: [...], author: [...],
//   'container-title': [...], volume, issue, page, DOI, ISSN, published }
```

--------------------------------

### Dispatch Citoid Request

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

The main internal entry point that processes a CitoidRequest object, auto-detects the identifier type, dispatches to the correct resolution method, and returns a promise resolving to the fully populated CitoidRequest.

```javascript
const CitoidService = require('./lib/CitoidService');
const CitoidRequest = require('./lib/CitoidRequest');

// Inside an Express route handler:
const citoid = new CitoidService(app); // app has conf, metrics, logger

// citoid.request() is called with an already-constructed CitoidRequest
citoid.request(cr).then((completedCr) => {
  res.status(completedCr.response.responseCode)
     .type(app.formats[completedCr.format])
     .send(completedCr.response.body);
}, (failedCr) => {
  res.status(failedCr.response.responseCode)
     .type(app.formats[failedCr.format])
     .send(failedCr.response.body);
});
```

--------------------------------

### Resolve PubMed/PMC Citation

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Resolves a PMID or PMCID to citation data by constructing the canonical PubMed/PMC URL and sending it through Zotero or the PubMed ID converter API to obtain a DOI, then delegating to `requestFromDOI`.

```bash
# Direct API call using a PMID
curl "http://localhost:1970/mediawiki/20478883"
```

--------------------------------

### Direct API call using a PMCID

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Retrieve citation metadata directly using a PubMed Central ID (PMCID).

```APIDOC
## Direct API call using a PMCID
GET /mediawiki/{pmcid}

### Description
Retrieves citation metadata using a provided PubMed Central ID (PMCID).

### Endpoint
`/mediawiki/{pmcid}`

### Example
```bash
curl "http://localhost:1970/mediawiki/PMC2880113"
```

### Response Example (Success)
```json
{
  "itemType": "journalArticle",
  "PMID": "20478883",
  "PMCID": "2880113",
  "DOI": "10.1038/..",
  "source": ["PubMed", "Zotero"]
}
```
```

--------------------------------

### Detect Input Type for Citoid Request

Source: https://context7.com/wikimedia/mediawiki-services-citoid/llms.txt

Parses the raw search string from a CitoidRequest using regex patterns to route the request to the appropriate resolution strategy. Handles various identifier types including URLs, DOIs, PubMed/PMC IDs, QIDs, ISBNs, and open text search.

```javascript
// The method is called internally by CitoidService.request().
// Detection priority (first match wins):
//   1. PMC URL  → requestFromPM (pmcid)
//   2. PMID URL → requestFromPM (pmid)
//   3. http/www URL → requestFromURL
//   4. Bare DOI → requestFromDOI
//   5. Wikidata QID (Q12345) → requestFromURL (wikidata.org)
//   6. PMCID (PMC1234567) → requestFromPM
//   7. ISBN → requestToZotISBN  (only if zotero enabled)
//   8. PMID / numeric string → requestFromPM
//   9. domain-like string → requestFromURL
//  10. Open text query → requestFromSearch (CrossRef) + URI extraction

// Example: search = "https://www.ncbi.nlm.nih.gov/pubmed/20478883"
//   → detected as PMID URL → requestFromPM({ idType: 'pmid', pmid: '20478883' })

// Example: search = "10.1038/nature09210"
//   → detected as bare DOI → requestFromDOI({ doi: '10.1038/nature09210' })

// Example: search = "Q180445"
//   → detected as QID → requestFromURL('https://www.wikidata.org/wiki/Q180445')
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.