API docs by Redocly

Audnexus (dev-deed60ad0197)

Download OpenAPI specification:

URL: https://github.com/laxamentumtech/audnexus License: GPL v3

Aggegate audiobook data

Find out more about Audnexus

Authors

Author functions

Find authors by name

Returns a list of authors, based on search query provided

query Parameters
name
required
string

Name to search with

region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
[
  • {
    }
]

Find author by ID

Returns a single author

path Parameters
ASIN
required
string

ID of author to return

query Parameters
update
string
Enum: "0" "1"

Have server check for updated data upstream

region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
{
  • "asin": "B00G0WYW92",
  • "description": "ANDY WEIR built a two-decade career as a software engineer until the success of his first published novel, The Martian, allowed him to live out his dream of writing full-time. He is a lifelong space nerd and a devoted hobbyist of such subjects as relativistic physics, orbital mechanics, and the history of manned spaceflight. He also mixes a mean cocktail. He lives in California.",
  • "genres": [
    ],
  • "image": "https://images-na.ssl-images-amazon.com/images/S/amzn-author-media-prod/dcqug62o4s52ubd61ogont4t3l.jpg",
  • "name": "Andy Weir",
  • "region": "us",
  • "similar": [
    ]
}

Deletes a author

Deletes a single author

path Parameters
ASIN
required
string

Author id to delete

query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Books

Book functions

Find book by ID

Returns a single book

path Parameters
ASIN
required
string

ID of book to return

query Parameters
seedAuthors
number
Enum: 0 1

Whether to seed authors of book

update
number
Enum: 0 1

Have server check for updated data upstream

region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "authors": [
    ],
  • "copyright": 2021,
  • "description": "Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish. Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it....",
  • "formatType": "unabridged",
  • "genres": [
    ],
  • "image": "https://m.media-amazon.com/images/I/91vS2L5YfEL.jpg",
  • "isAdult": false,
  • "isbn": "9781603935470",
  • "language": "english",
  • "literatureType": "fiction",
  • "narrators": [
    ],
  • "publisherName": "Audible Studios",
  • "rating": "4.9",
  • "ratings": {
    },
  • "region": "us",
  • "releaseDate": "2021-05-04T00:00:00.000Z",
  • "runtimeLengthMin": 970,
  • "summary": "<p><b><i>Winner of the 2022 Audie Awards' Audiobook of the Year</i></b></p> <p><b><i>Number-One Audible and </i></b><b>New York Times</b><b><i> Audio Best Seller</i></b></p> <p><b><i>More than one million audiobooks sold</i></b></p> <p><b>A lone astronaut must save the earth from disaster in this incredible new science-based thriller from the number-one </b><b><i>New York Times</i></b><b> best-selling author of </b><b><i>The Martian</i></b><b>.</b></p> <p>Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish.</p> <p>Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it.</p> <p>All he knows is that he's been asleep for a very, very long time. And he's just been awakened to find himself millions of miles from home, with nothing but two corpses for company.</p> <p>His crewmates dead, his memories fuzzily returning, he realizes that an impossible task now confronts him. Alone on this tiny ship that's been cobbled together by every government and space agency on the planet and hurled into the depths of space, it's up to him to conquer an extinction-level threat to our species.</p> <p>And thanks to an unexpected ally, he just might have a chance.</p> <p>Part scientific mystery, part dazzling interstellar journey, <i>Project Hail Mary</i> is a tale of discovery, speculation, and survival to rival <i>The Martian</i> - while taking us to places it never dreamed of going.</p> <p>PLEASE NOTE: To accommodate this audio edition, some changes to the original text have been made with the approval of author Andy Weir.</p>",
  • "title": "Project Hail Mary"
}

Deletes a book

Deletes a single book

path Parameters
ASIN
required
string

Book id to delete

query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Book artwork gallery

Returns the retained artwork gallery for one exact asin+region pair, newest immutable sequence first. Parsed (Amazon image ID) and unparsed references are both listed; unparsed entries carry a null imageId. Live-observed references report the URL verbatim, and unparsed live-observed entries expose their exact URL through their rendition entries. Imported legacy references report the server-side stored URL and import time via legacy with an empty renditions array — their URL is not exposed through rendition entries.

Read-only: served from retained data, and may answer even when the current book is deleted. 200 for a pending (no state yet) trusted current book, returning empty items; 409 for an unresolved identity conflict only while no established history state exists (an established retained state always wins and reads 200); 404 for a wholly unknown resource; 400 for invalid path/query input.

path Parameters
ASIN
required
string
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

limit
string^\d{1,3}$
Default: "50"

Page size, 1-100 (declared as a decimal digit string)

cursor
string <= 2048 characters

Opaque keyset continuation cursor from a previous page. Bound to the exact asin+region pair that issued it; reusing it for any other pair returns 400 ("Cursor does not match").

Responses

Response samples

Content type
application/json
{
  • "asin": "string",
  • "region": "string",
  • "tracking": {
    },
  • "items": [
    ],
  • "nextCursor": "string"
}

Book history

Returns stored metadata/artwork history for one exact asin+region pair, newest revision first. Each item is a revision identity with its changed-field names; use the detail endpoint for a revision's full stored delta. The optional field filter narrows to revisions that changed that field. Read-only, served from retained data and may answer even when the current book is deleted. 200 for an established (retained) resource and for a pending trusted current book (empty items, pending tracking); 409 for an unresolved identity conflict only while no established history state exists (an established retained state always wins and reads 200); 404 for a wholly unknown resource. An invalid cursor on an established resource is 400; on an unknown resource the existence check runs first and is 404.

path Parameters
ASIN
required
string
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

limit
string^\d{1,3}$
Default: "50"

Page size, 1-100 (declared as a decimal digit string)

cursor
string <= 2048 characters

Opaque keyset continuation cursor from a previous page. Bound to the exact asin+region pair (and field filter, if any) that issued it; reusing it for a different pair or filter returns 400 ("Cursor does not match").

field
string
Enum: "title" "subtitle" "authors" "narrators" "publisherName" "description" "summary" "isbn" "language" "formatType" "copyright" "releaseDate" "runtimeLengthMin" "seriesPrimary" "seriesSecondary" "genres" "literatureType" "isAdult" "artwork"

Responses

Response samples

Content type
application/json
{
  • "asin": "string",
  • "region": "string",
  • "tracking": {
    },
  • "items": [
    ],
  • "nextCursor": "string"
}

Book history revision detail

Returns the complete stored delta for one revision of an exact asin+region pair. The revision number is exact (no 0, no leading zeros, safe integer bound). An unknown, cross-book, cross-region, or not-yet-existing revision is always 404, even for a pending resource.

path Parameters
ASIN
required
string
revision
required
string^[1-9][0-9]*$
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
application/json
{
  • "asin": "string",
  • "region": "string",
  • "revision": 0,
  • "observedAt": "2019-08-24T14:15:22Z",
  • "changedFields": [
    ],
  • "policies": {
    },
  • "changes": { }
}

Backfill ratings

Re-fetches every stored book that is missing the ratings field and persists the rating counts and star distributions. Admin-only; disabled unless the UPDATE_STATS environment flag is enabled.

The backfill runs in the background: the endpoint returns 202 immediately and the final summary (total / updated / skipped / failed) is logged, not returned. Pre-order books (releaseDate in the future) are reported as skipped — their refreshed data is not persisted while pre-release, so they cannot be counted as updated. Only one backfill can be queued or running at a time (queue-wide, durable across API restarts); concurrent requests normally receive 409, though a racing request that is deduped on the job id before the running check observes it receives 202 with the same job id.

header Parameters
x-admin-token
required
string

Admin token used to authorize the backfill. Set via the ADMIN_TOKEN environment variable.

Responses

Response samples

Content type
application/json
{
  • "message": "Ratings backfill started",
  • "id": "backfill-ratings"
}

Chapters

Chapter functions

Find chapters by ASIN

Returns a single book's chapters

path Parameters
ASIN
required
string

ID of book to return

query Parameters
update
number
Enum: 0 1

Have server check for updated data upstream

region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "brandIntroDurationMs": 2043,
  • "brandOutroDurationMs": 5061,
  • "chapters": [
    ],
  • "isAccurate": true,
  • "region": "us",
  • "runtimeLengthMs": 58252995,
  • "runtimeLengthSec": 58253
}

Delete chapters by ASIN

Deletes a single book's chapters

path Parameters
ASIN
required
string

Audible.com ID

query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Search

Search functions

Find authors by name

Returns a list of authors, based on search query provided

query Parameters
name
required
string

Name to search with

region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

Responses

Response samples

Content type
[
  • {
    }
]

Health

Health check functions

Health check

Returns service health status including MongoDB and Redis connectivity

Responses

Response samples

Content type
application/json
{
  • "status": "healthy",
  • "timestamp": "2024-01-15T10:30:00.000Z",
  • "checks": {
    }
}

Metrics

Performance metrics

Performance metrics

Returns performance metrics including memory usage, uptime, and request statistics. This endpoint requires authentication via either x-metrics-token header or IP-based access control.

Authorizations:
ApiKeyAuthipAuth

Responses

Response samples

Content type
application/json
{
  • "memory": {
    },
  • "uptime": 86400,
  • "requests": {
    }
}