Skip to main content

MetadataAutoMatchResponse

Response after auto-matching metadata

appliedFieldsstring[]required

Fields that were applied

externalUrlstring | nullnullable

External URL (link to matched item on provider)

matchedResult object

The search result that was matched

alternateTitlesstring[]

Alternative titles

coverUrlstring | nullnullable

Cover image URL

externalIdstringrequired

External ID from the provider

preview object

Preview data for search results

authorsstring[]

Author names (book search results)

bookCountinteger,null<int32>nullable

Number of books in the series (if known by the provider)

descriptionstring | nullnullable

Short description

formatstring | nullnullable

Content format discriminator (e.g. manga, novel, light_novel, manhwa, manhua, comic, webtoon, one_shot).

Free-form string at the protocol layer; the UI maps known values to colored badges and falls back to a neutral badge for anything else.

genresstring[]

Genres

ratingnumber,null<double>nullable

Rating

statusstring | nullnullable

Status string (series search results)

relevanceScorenumber,null<double>nullable

Relevance score (0.0-1.0). Optional - if not provided, result order indicates relevance.

titlestringrequired

Primary title

yearinteger,null<int32>nullable

Year of publication

messagestringrequired

Message

skippedFields object[]required

Fields that were skipped (with reasons)

  • Array [
  • fieldstringrequired

    Field name

    reasonstringrequired

    Reason for skipping

  • ]
  • successbooleanrequired

    Whether the operation succeeded

    MetadataAutoMatchResponse
    {
    "appliedFields": [
    "string"
    ],
    "externalUrl": "string",
    "matchedResult": {
    "alternateTitles": [
    "string"
    ],
    "coverUrl": "string",
    "externalId": "string",
    "preview": {
    "authors": [
    "string"
    ],
    "bookCount": 0,
    "description": "string",
    "format": "string",
    "genres": [
    "string"
    ],
    "rating": 0,
    "status": "string"
    },
    "relevanceScore": 0,
    "title": "string",
    "year": 0
    },
    "message": "string",
    "skippedFields": [
    {
    "field": "string",
    "reason": "string"
    }
    ],
    "success": true
    }