Bigeye

Bigeye Agent Service API

The AgentService API from Bigeye — 5 operation(s) for agentservice.

GitHub OpenAPI

Operations 6

GET /api/v1/agent/public-key/bigeye Get the public key the user's company Agent should use when sending messages to… #
GET /api/v1/agent/public-key Get the public key Bigeye currently has for the user's company Agent #
PUT /api/v1/agent/public-key Set the public key Bigeye will use to encrypt messages to the user's company… #
GET /api/v1/agent/health/ping Synchronously ping all agent sources for their health status #
GET /api/v1/agent/health Retrieve the latest health status of all agent sources #
GET /api/v1/agent/validate/source/{sourceId} Validate that the agent is working for a given source #

Documentation

📖
Documentation
https://docs.bigeye.com/docs/api-user-guide
📖
APIReference
https://docs.bigeye.com/reference
📖
Documentation
https://docs.bigeye.com/docs/monitoring
📖
Documentation
https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-agentservice-api-openapi.yml

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/bigeye:bigeye-agentservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

bigeye-agentservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Metadata Agent Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: AgentService
paths:
  /api/v1/agent/public-key/bigeye:
    get:
      operationId: AgentService_GetBigeyePublicKey
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedPublicKeyMessage'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get the public key the user's company Agent should use when sending messages to…
      tags:
      - AgentService
  /api/v1/agent/public-key:
    get:
      operationId: AgentService_GetCompanyPublicKey
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedPublicKeyMessage'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get the public key Bigeye currently has for the user's company Agent
      tags:
      - AgentService
    put:
      operationId: AgentService_SetCompanyPublicKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedPublicKeyMessage'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedPublicKeyMessage'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Set the public key Bigeye will use to encrypt messages to the user's company…
      tags:
      - AgentService
  /api/v1/agent/health/ping:
    get:
      operationId: AgentService_PingAgents
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedAgentHealthResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Synchronously ping all agent sources for their health status
      tags:
      - AgentService
  /api/v1/agent/health:
    get:
      operationId: AgentService_RetrieveAgentHealth
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedAgentHealthResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Retrieve the latest health status of all agent sources
      tags:
      - AgentService
  /api/v1/agent/validate/source/{sourceId}:
    get:
      operationId: AgentService_ValidateAgentForSource
      parameters:
      - in: path
        name: sourceId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedSourceValidationResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Validate that the agent is working for a given source
      tags:
      - AgentService
components:
  schemas:
    generatedSourceValidationResponse:
      properties:
        errors:
          items:
            type: string
          type: array
        isValid:
          type: boolean
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
    generatedAgentHealthResponse:
      properties:
        failures:
          items:
            $ref: '#/components/schemas/generatedFailedUpdate'
          type: array
        sources:
          items:
            $ref: '#/components/schemas/generatedAgentHealthInfo'
          type: array
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedFailedUpdate:
      properties:
        id:
          format: int32
          type: integer
        reason:
          type: string
      type: object
    generatedAgentHealthStatus:
      default: AGENT_HEALTH_STATUS_UNSPECIFIED
      enum:
      - AGENT_HEALTH_STATUS_UNSPECIFIED
      - AGENT_HEALTH_STATUS_HEALTHY
      - AGENT_HEALTH_STATUS_SLOW_BUT_UP
      - AGENT_HEALTH_STATUS_DOWN
      - AGENT_HEALTH_STATUS_NO_DATA
      type: string
    generatedAgentHealthInfo:
      properties:
        agentHealthStatus:
          $ref: '#/components/schemas/generatedAgentHealthStatus'
        crossSourceAgentHealthStatus:
          $ref: '#/components/schemas/generatedAgentHealthStatus'
        lastHeartbeatLatencyMillis:
          format: int64
          type: string
        lastHeartbeatReceivedAt:
          format: int64
          type: string
        lastHeartbeatSentAt:
          format: int64
          type: string
        sensitiveDataAgentHealthStatus:
          $ref: '#/components/schemas/generatedAgentHealthStatus'
        sourceId:
          format: int32
          type: integer
      type: object
    generatedPublicKeyMessage:
      properties:
        publicKey:
          type: string
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: harvested
  publisher: Bigeye
  source: https://docs.bigeye.com/openapi/metadata.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)