GroundRoute AI Console Byok API

The console-byok API from GroundRoute AI — 3 operation(s) for console-byok.

GitHub OpenAPI

Operations 4

GET /console/provider-keys List Keys #
POST /console/provider-keys Add Key #
GET /console/provider-keys/catalog Provider Catalog #
DELETE /console/provider-keys/{key_id} Delete Key #

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-console-byok-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

groundroute-ai-console-byok-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: GroundRoute Console Byok API
  version: 0.3.0
tags:
- name: console-byok
paths:
  /console/provider-keys:
    get:
      tags:
      - console-byok
      summary: List Keys
      operationId: list_keys_console_provider_keys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProviderKeyView'
                type: array
                title: Response List Keys Console Provider Keys Get
    post:
      tags:
      - console-byok
      summary: Add Key
      operationId: add_key_console_provider_keys_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddProviderKeyRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderKeyView'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/provider-keys/catalog:
    get:
      tags:
      - console-byok
      summary: Provider Catalog
      description: 'The BYOK catalog: canonical allowed slugs (single source = ALLOWED_PROVIDERS, so the frontend

        stops hardcoding) PLUS each provider''s verified free-tier facts for the volume-aware onboarding

        flow (free allowance, signup link, card-required, role, per-entry verified date). Backend is the

        source of truth so volatile free tiers stay correct; the frontend renders "free tiers as of

        ". Identical for every tenant; authed for parity with the vault.'
      operationId: provider_catalog_console_provider_keys_catalog_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderCatalog'
  /console/provider-keys/{key_id}:
    delete:
      tags:
      - console-byok
      summary: Delete Key
      operationId: delete_key_console_provider_keys__key_id__delete
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Delete Key Console Provider Keys  Key Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProviderKeyView:
      properties:
        id:
          type: string
          title: Id
        provider:
          type: string
          title: Provider
        fingerprint_prefix:
          type: string
          title: Fingerprint Prefix
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - provider
      - fingerprint_prefix
      - status
      - created_at
      title: ProviderKeyView
    AddProviderKeyRequest:
      properties:
        provider:
          type: string
          maxLength: 32
          title: Provider
        key:
          type: string
          maxLength: 4096
          minLength: 1
          title: Key
      type: object
      required:
      - provider
      - key
      title: AddProviderKeyRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderFreeTier:
      properties:
        slug:
          type: string
          title: Slug
        display_name:
          type: string
          title: Display Name
        free_amount:
          type: string
          title: Free Amount
        free_type:
          type: string
          title: Free Type
        card_required:
          type: boolean
          title: Card Required
        signup_url:
          type: string
          title: Signup Url
        use_in_free_pool:
          type: boolean
          title: Use In Free Pool
        verified_at:
          type: string
          title: Verified At
      additionalProperties: false
      type: object
      required:
      - slug
      - display_name
      - free_amount
      - free_type
      - card_required
      - signup_url
      - use_in_free_pool
      - verified_at
      title: ProviderFreeTier
      description: One provider's free-tier facts for the onboarding flow (#5's exact per-provider contract).
    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
    ProviderCatalog:
      properties:
        providers:
          items:
            $ref: '#/components/schemas/ProviderFreeTier'
          type: array
          title: Providers
      additionalProperties: false
      type: object
      required:
      - providers
      title: ProviderCatalog
      description: 'Catalog response, exactly #5''s contract: a list of per-provider free-tier objects.'