/ximalaya/sounds/search

POST /api/ximalaya/sounds/search

Price: 20 credits

Search individual Ximalaya sounds (single audio episodes) by keyword

How to use it

Matches episode titles, so a show name returns that show's episodes scattered across every anchor who published it rather than the show itself - reach for album search when the user means the show. Whether an episode is paid, is video or is copyright-cleared is not part of a search result at all; fetch the sound when that is the question, rather than reading an episode as free from this response.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "三体", "蛊真人"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 3000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "most_played")

Response

• @type string (default: "XimalayaSearchSound")
• id integer required
• url string required
• track_title string nullable
• image string nullable
• duration number nullable
• album_id integer nullable
• album_title string nullable
• album_url string nullable
• anchor_id integer nullable
• anchor_name string nullable
• anchor_url string nullable
• play_count integer nullable
• created_at integer nullable
• updated_at integer 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 — The entity was not found, or a precondition failed 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.