Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Smart search combining web and academic results

Felo API Support
MIT
服务器:https://openapi.felo.ai
客户端库
Shell Curl

Smart search combining web and academic results

​

Search the web and academic sources together, for questions that straddle both. ⚠️ Parameters go in the query string: query (required), max_num_results, as_ylo/as_yhi. Returns a search id and results[]; the entry shape varies by source — every result has title, link and snippet, and academic ones additionally carry authors and number_of_citations, so treat those two as optional rather than assuming they are there. Use it when you do not know in advance which kind of source will answer. When you do, post_scholar_search_web or post_scholar_search_scholar is more predictable. Keep the id for post_scholar_search_explain.

查询参数
  • query
    类型: string
    必填

    Search query for scholarly materials

  • max_num_results
    类型: integer
    最小值:  
    1
    最大值:  
    100

    Maximum number of search results to return, up to 100

  • as_ylo
    类型: integer
    最小值:  
    1900
    最大值:  
    2030    可为 null

    Year of publication lower bound

  • as_yhi
    类型: integer
    最小值:  
    1900
    最大值:  
    2030    可为 null

    Year of publication upper bound

响应
  • 200
    类型: object · SmartSearchResponse

    Successful search response

    • id
      类型: string
      必填

      Unique identifier for the search request

    • results
      类型: array object[] · SmartResult[]
      必填

      List of smart search results combining web and academic content

      • link
        类型: string 格式: uri
        必填

        URL to access the content

      • snippet
        类型: string
        必填

        Brief summary or abstract

      • title
        类型: string
        必填

        Title of the result

      • authors
        类型: array string[]

        List of authors (for academic content)

      • number_of_citations
        类型: integer
        最小值:  
        0

        Number of citations (for academic content)

      • relevance_score
        类型: number
        最小值:  
        0
        最大值:  
        1

        Relevance score of the result

      • type
        类型: string 枚举

        Type of the result

        值
        • web
        • academic
    • search_type
      类型: string 枚举

      Type of search results included

      值
      • web
      • academic
      • hybrid
    application/json
  • 400
    类型: object · ErrorResponse

    Bad request - invalid parameters

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 401
    类型: object · ErrorResponse

    Unauthorized - invalid or missing API key

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429
    类型: object · ErrorResponse

    Rate limit exceeded

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 500
    类型: object · ErrorResponse

    Internal server error

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/scholar/search/mixed
curl 'https://openapi.felo.ai/v1/beta/scholar/search/mixed?query=machine%20learning' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "string",
  "results": [
    {
      "title": "string",
      "link": "https://example.com",
      "snippet": "string",
      "authors": [
        "string"
      ],
      "number_of_citations": 0,
      "type": "web",
      "relevance_score": 0
    }
  ],
  "search_type": "web"
}

Successful search response

Smart search combining web and academic results