爱域查 API

openapi: 3.1.0
info:
  title: 爱域查 API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 2 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; 爱域查 has published no machine-readable contract that the pipeline
    could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 1
    documentation: 1
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: oss
  x-sources:
  - https://aiyucha.com/en/api
  - https://aiyucha.com/zh/api
paths:
  /v1/batch-query:
    post:
      operationId: post_v1_batch_query
      tags:
      - Batch Query
      summary: POST /v1/batch-query
      x-source: https://aiyucha.com/en/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1BatchQueryRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1BatchQueryResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://aiyucha.com/v1/batch-query  -H \"Authorization: Bearer odi_live_...\"  -H \"Idempotency-Key: batch-20261001-001\"\
          \  -H \"Content-Type: application/json\"  -d '{\n \"type\": \"icp\",\n \"domains\": [\"example.cn\", \"example.com\"],\n \"locale\"\
          : \"zh\"\n }' \n POLL RESULTS \n Poll while the job is running \n GET /v1/batch-query/{job_id}\n→ {\n \"contract_version\": \"batch-query-v1\"\
          ,\n \"job_id\": \"...\",\n \"type\""
  /v1/batch-query/{jobId}:
    get:
      operationId: get_v1_batch_query_jobId
      tags:
      - Batch Query
      summary: Read job status, progress counters, failures, and normalized per-domain results.
      description: Poll the job endpoint to obtain progress and results for a submitted batch query.
      x-source: https://aiyucha.com/en/api
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1BatchQueryJobidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1BatchQueryRequest:
      type: object
      properties:
        type:
          type: string
        domains:
          type: array
          items:
            type: string
        locale:
          type: string
    PostV1BatchQueryResponse:
      type: object
      properties:
        contract_version:
          type: string
        job_id:
          type: string
        type:
          type: string
        status:
          type: string
        total:
          type: integer
        completed:
          type: integer
        failed:
          type: integer
        progress_percent:
          type: number
        items:
          type: array
          items:
            type: object
            properties:
              domain:
                type: string
              status:
                type: string
              result:
                type: object
              error:
                type:
                - string
                - 'null'
    GetV1BatchQueryJobidResponse:
      type: object
      properties:
        contract_version:
          type: string
          description: Version of the batch‑query contract.
        job_id:
          type: string
          description: Identifier of the job.
        type:
          type: string
          description: The check type of the job.
        status:
          type: string
          description: Current job status (e.g., running, completed).
        total:
          type: integer
          description: Total number of domains in the batch.
        completed:
          type: integer
          description: Number of domains that have completed processing.
        failed:
          type: integer
          description: Number of domains that failed processing.
        progress_percent:
          type: number
          description: Overall progress percentage.
        items:
          type: array
          description: Array of per‑domain result objects.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Batch Query