Groundwork Open Source agent API

The agent API from Groundwork Open Source — 8 operation(s) for agent.

Operations 8

POST /config
GET /identity
POST /reset-nats
POST /start
GET /stats
GET /status
POST /stop
GET /version

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/groundwork-open-source-agent-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.

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

OpenAPI Specification

groundwork-open-source-agent-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact: {}
  title: Groundwork Open Source Agent API
tags:
- name: agent
paths:
  /config:
    post:
      description: The following API endpoint can be used to Agent configure.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /identity:
    get:
      description: The following API endpoint can be used to get a TCG agent id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_gwos_tcg_sdk_transit.AgentIdentity'
      tags:
      - agent
  /reset-nats:
    post:
      description: The following API endpoint can be used to reset NATS queues.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/services.ConnectorStatusDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /start:
    post:
      description: The following API endpoint can be used to start NATS dispatcher.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/services.ConnectorStatusDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /stats:
    get:
      description: The following API endpoint can be used to get TCG statistics.
      parameters:
      - description: Auth header
        in: header
        name: gwos-app-name
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/services.AgentStatsExt'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /status:
    get:
      description: The following API endpoint can be used to get TCG status.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/services.ConnectorStatusDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /stop:
    post:
      description: The following API endpoint can be used to stop NATS dispatcher.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/services.ConnectorStatusDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
  /version:
    get:
      description: The following API endpoint can be used to return actual TCG connector version.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        schema:
          type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/config.BuildInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
      tags:
      - agent
components:
  schemas:
    github_com_gwos_tcg_sdk_transit.AgentIdentity:
      properties:
        agentId:
          type: string
        appName:
          type: string
        appType:
          type: string
      type: object
    logzer.LogRecord:
      type: object
    services.ConnectorStatusDTO:
      properties:
        connectorStatus:
          type: string
        jobId:
          type: integer
      type: object
    services.AgentStatsExt:
      properties:
        agentId:
          type: string
        appName:
          type: string
        appType:
          type: string
        bytesSent:
          $ref: '#/components/schemas/expvar.Int'
        executionTimeInventory:
          $ref: '#/components/schemas/expvar.Int'
        executionTimeMetrics:
          $ref: '#/components/schemas/expvar.Int'
        lastErrors:
          items:
            $ref: '#/components/schemas/logzer.LogRecord'
          type: array
        lastEventsRun:
          $ref: '#/components/schemas/expvar.Int'
        lastInventoryRun:
          $ref: '#/components/schemas/expvar.Int'
        lastMetricsRun:
          $ref: '#/components/schemas/expvar.Int'
        messagesSent:
          $ref: '#/components/schemas/expvar.Int'
        metricsSent:
          $ref: '#/components/schemas/expvar.Int'
        upSince:
          $ref: '#/components/schemas/expvar.Int'
      type: object
    config.BuildInfo:
      properties:
        tag:
          type: string
        time:
          type: string
      type: object
    expvar.Int:
      type: object