Chinaready Search API

The Search API from Chinaready — 2 operation(s) for search.

GitHub OpenAPI

Operations 2

POST /search Semantic search over chinaready.co content (retrieval for AI tools) #
POST /api/search Site search over the Chinaready corpus (article-level, AI-ranked) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/chinaready-co:chinaready-co-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

chinaready-co-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Chinaready Co Search API
  version: 0.5.0
  description: 'Operations tagged Search across 2 of this provider''s published API definitions: chinaready-co-openapi.json, chinaready-co-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://chinaready.co
tags:
- name: Search
paths:
  /search:
    servers:
    - url: https://search.chinaready.co
    post:
      summary: Semantic search over chinaready.co content (retrieval for AI tools)
      operationId: aiSearch
      description: Unauthenticated semantic search over the Chinaready corpus — public guides, services, and FAQ content hosted by Cloudflare AI Search. Each returned excerpt begins with a url/title/type source header whose url is the absolute chinaready.co page link; cite that URL in answers. Shared endpoint with the site's Ask AI panel; rate limited (~120 requests/minute). A Model Context Protocol server exposing the same corpus lives at /mcp on this host.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - messages
              properties:
                messages:
                  type: array
                  maxItems: 10
                  items:
                    type: object
                    required:
                    - role
                    - content
                    properties:
                      role:
                        type: string
                        enum:
                        - user
                        - assistant
                      content:
                        type: string
      responses:
        '200':
          description: Retrieval chunks with source URLs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      query_kind:
                        type: string
                      search_query:
                        type: string
                      chunks:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                            score:
                              type: number
                            text:
                              type: string
                              description: Excerpt text; begins with a url/title/type source header whose url is the absolute chinaready.co page URL to cite.
        '429':
          description: Rate limit exceeded
      tags:
      - Search
  /api/search:
    post:
      summary: Site search over the Chinaready corpus (article-level, AI-ranked)
      operationId: postSiteSearch
      description: Per-IP rate limited retrieval proxy over the same corpus as the Ask AI panel and search.chinaready.co. Accepts a single query string; returns article-level results (best chunk score per URL, snippet included), ranked by relevance. Generation-free.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - query
              properties:
                query:
                  type: string
                  minLength: 1
                  maxLength: 200
      responses:
        '200':
          description: Ranked article results or empty action
          content:
            application/json:
              schema:
                type: object
                properties:
                  action:
                    type: string
                    enum:
                    - results
                    - empty
                  query:
                    type: string
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        title:
                          type: string
                        type:
                          type: string
                        score:
                          type: number
                        snippet:
                          type: string
        '400':
          description: Invalid JSON or missing/oversized query
        '429':
          description: Per-IP rate limit exceeded
      tags:
      - Search
    servers:
    - url: https://chinaready.co
x-refined-from:
- chinaready-co-openapi.json
- chinaready-co-openapi.yml