GroundRoute AI

GroundRoute AI Search API

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

GitHub OpenAPI

Operations 2

POST /v1/search Search #
POST /v1/search/compat Search Compat #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/groundroute-ai/openapi/groundroute-ai-search-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-shim-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-drill-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-overview-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-row-schema.json

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/groundroute-ai:groundroute-ai-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.

GitHub Google LinkedIn

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

OpenAPI Specification

groundroute-ai-search-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GroundRoute Search API
  version: 0.3.0
tags:
- name: Search
paths:
  /v1/search:
    post:
      summary: Search
      description: Authenticated search. All *_meta blocks are always present in the response.
      operationId: search_v1_search_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Search
  /v1/search/compat:
    post:
      summary: Search Compat
      description: OpenAI/Tavily-compatible search endpoint. Same auth as /v1/search.
      operationId: search_compat_v1_search_compat_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_ShimBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Search
components:
  schemas:
    SearchResponse:
      properties:
        request_id:
          type: string
          format: uuid
          title: Request Id
        tenant_id:
          type: string
          title: Tenant Id
        results:
          items:
            $ref: '#/components/schemas/SearchResult'
          type: array
          title: Results
        answer:
          anyOf:
          - type: string
          - type: 'null'
          title: Answer
        citations:
          items:
            $ref: '#/components/schemas/Citation'
          type: array
          title: Citations
        degraded:
          type: boolean
          title: Degraded
          default: false
        routing_meta:
          $ref: '#/components/schemas/RoutingMeta'
        cache_meta:
          $ref: '#/components/schemas/CacheMeta'
        quality_meta:
          $ref: '#/components/schemas/QualityMeta'
        usage_meta:
          $ref: '#/components/schemas/UsageMeta'
      additionalProperties: false
      type: object
      required:
      - request_id
      - tenant_id
      - routing_meta
      - cache_meta
      - quality_meta
      - usage_meta
      title: SearchResponse
    RoutingMeta:
      properties:
        strategy:
          $ref: '#/components/schemas/RoutingStrategy'
          default: price_led
        query_class:
          $ref: '#/components/schemas/QueryClass'
        chosen_engine:
          type: string
          title: Chosen Engine
        reason:
          type: string
          title: Reason
        candidates:
          items:
            $ref: '#/components/schemas/RoutingCandidate'
          type: array
          title: Candidates
        cost_usd:
          type: number
          title: Cost Usd
          default: 0.0
        latency_ms:
          type: integer
          title: Latency Ms
          default: 0
        degraded:
          type: boolean
          title: Degraded
          default: false
        failover_from:
          anyOf:
          - type: string
          - type: 'null'
          title: Failover From
        missing_engines:
          items:
            type: string
          type: array
          title: Missing Engines
      additionalProperties: false
      type: object
      required:
      - query_class
      - chosen_engine
      - reason
      title: RoutingMeta
    RoutingCandidate:
      properties:
        engine:
          type: string
          title: Engine
        cost_per_1k_usd:
          type: number
          title: Cost Per 1K Usd
        eligible:
          type: boolean
          title: Eligible
        picked:
          type: boolean
          title: Picked
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
      additionalProperties: false
      type: object
      required:
      - engine
      - cost_per_1k_usd
      - eligible
      - picked
      title: RoutingCandidate
    SearchRequest:
      properties:
        query:
          type: string
          maxLength: 2048
          minLength: 1
          title: Query
        mode:
          $ref: '#/components/schemas/Mode'
          default: auto
        max_results:
          type: integer
          maximum: 50.0
          minimum: 1.0
          title: Max Results
          default: 10
        freshness:
          anyOf:
          - $ref: '#/components/schemas/Freshness'
          - type: 'null'
        domains:
          items:
            type: string
          type: array
          title: Domains
        exclude_domains:
          items:
            type: string
          type: array
          title: Exclude Domains
        lang:
          anyOf:
          - type: string
            maxLength: 8
          - type: 'null'
          title: Lang
        country:
          anyOf:
          - type: string
            maxLength: 2
          - type: 'null'
          title: Country
        tenant_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Id
        is_byok:
          type: boolean
          title: Is Byok
          default: false
      type: object
      required:
      - query
      title: SearchRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RoutingStrategy:
      type: string
      enum:
      - price_led
      - learned
      - fanout
      title: RoutingStrategy
    CacheMeta:
      properties:
        cache_tier:
          $ref: '#/components/schemas/CacheTier'
          default: miss
        poolable:
          type: boolean
          title: Poolable
          default: false
        poolability_reason:
          type: string
          title: Poolability Reason
          default: cell_not_allowlisted
        screens_post_nfkc:
          type: boolean
          title: Screens Post Nfkc
          default: true
        freshness_bucket:
          type: string
          title: Freshness Bucket
          default: none
        cache_key_private:
          anyOf:
          - type: string
          - type: 'null'
          title: Cache Key Private
        cache_key_pooled:
          anyOf:
          - type: string
          - type: 'null'
          title: Cache Key Pooled
        cached_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Cached At
        ttl_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ttl Seconds
        cost_avoided_usd:
          type: number
          title: Cost Avoided Usd
          default: 0.0
        similarity:
          anyOf:
          - type: number
          - type: 'null'
          title: Similarity
      additionalProperties: false
      type: object
      title: CacheMeta
      description: '[src: Appendix D] — the §6.1 screens'' output surface.'
    CacheTier:
      type: string
      enum:
      - miss
      - exact_private
      - exact_pooled
      - semantic
      title: CacheTier
      description: '[src: Appendix D §D.6].'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Mode:
      type: string
      enum:
      - auto
      - web
      - news
      - academic
      - answer
      - page
      title: Mode
      description: Request intent hint; the router may refine it.
    QualityMeta:
      properties:
        quality_score:
          anyOf:
          - type: number
          - type: 'null'
          title: Quality Score
        components:
          additionalProperties:
            type: number
          type: object
          title: Components
        judge_sampled:
          type: boolean
          title: Judge Sampled
          default: false
        engine_agreement_rbo:
          anyOf:
          - type: number
          - type: 'null'
          title: Engine Agreement Rbo
      additionalProperties: false
      type: object
      title: QualityMeta
      description: '[src: §B.1 composite] — MONITORING/flywheel only, NOT a live router input.'
    SearchResult:
      properties:
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
        title:
          type: string
          title: Title
        snippet:
          type: string
          title: Snippet
          default: ''
        content:
          anyOf:
          - type: string
          - type: 'null'
          title: Content
        score:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Score
        source_engine:
          type: string
          title: Source Engine
        published_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Published At
        rank:
          type: integer
          minimum: 0.0
          title: Rank
      additionalProperties: false
      type: object
      required:
      - url
      - title
      - source_engine
      - rank
      title: SearchResult
    UsageMeta:
      properties:
        request_id:
          type: string
          format: uuid
          title: Request Id
        tenant_id:
          type: string
          title: Tenant Id
        account_id:
          type: string
          title: Account Id
        api_key_id:
          type: string
          title: Api Key Id
        ts:
          type: string
          format: date-time
          title: Ts
        billable:
          type: boolean
          title: Billable
          default: true
        searches_counted:
          type: integer
          title: Searches Counted
          default: 1
        provider_key_source:
          $ref: '#/components/schemas/ProviderKeySource'
          default: platform
        cost_usd:
          type: number
          title: Cost Usd
          default: 0.0
      additionalProperties: false
      type: object
      required:
      - request_id
      - tenant_id
      - account_id
      - api_key_id
      - ts
      title: UsageMeta
    ProviderKeySource:
      type: string
      enum:
      - platform
      - byok
      title: ProviderKeySource
    _ShimBody:
      properties:
        query:
          anyOf:
          - type: string
          - type: 'null'
          title: Query
        q:
          anyOf:
          - type: string
          - type: 'null'
          title: Q
        search_query:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Query
        input:
          anyOf:
          - type: string
          - type: 'null'
          title: Input
        max_results:
          anyOf:
          - type: integer
            maximum: 200.0
            minimum: 1.0
          - type: 'null'
          title: Max Results
        num_results:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Results
        count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Count
        k:
          anyOf:
          - type: integer
          - type: 'null'
          title: K
        mode:
          anyOf:
          - type: string
          - type: 'null'
          title: Mode
        search_depth:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Depth
        topic:
          anyOf:
          - type: string
          - type: 'null'
          title: Topic
        include_domains:
          items:
            type: string
          type: array
          title: Include Domains
        domains:
          items:
            type: string
          type: array
          title: Domains
        exclude_domains:
          items:
            type: string
          type: array
          title: Exclude Domains
        days:
          anyOf:
          - type: integer
          - type: 'null'
          title: Days
        time_range:
          anyOf:
          - type: string
          - type: 'null'
          title: Time Range
        recency:
          anyOf:
          - type: string
          - type: 'null'
          title: Recency
      type: object
      title: _ShimBody
      description: Accepts any SDK field shape; unknown fields are dropped (extra=ignore).
    QueryClass:
      type: string
      enum:
      - academic
      - web
      - news
      - page
      - answer
      title: QueryClass
      description: 'Router/cache class — the 5 route classes [src: route_bench, bench_queries_v2].'
    Freshness:
      type: string
      enum:
      - fresh
      - semi
      - static
      title: Freshness
      description: Explicit client override of freshness intent.
    Citation:
      properties:
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        index:
          type: integer
          minimum: 0.0
          title: Index
      additionalProperties: false
      type: object
      required:
      - url
      - index
      title: Citation