Govly Signals API

openapi: 3.2.0
info:
  title: Govly Tools Signals API
  version: 1.0.0-alpha
  description: 'ALPHA / UNSTABLE: This API is still in active development. Endpoint behavior, request fields, response fields, error codes, and operation names may change before the Tools API is declared stable.

    REST-callable tool surface for agent and automation workflows. Agents are the primary consumer, but integrations can be built on this API. Responses are JSON for typed clients; MCP tools may render action results into text-oriented formats separately.

    Validating requests: validate against this schema in your client before sending. Govly ignores a request field it does not recognize rather than rejecting it, so a misspelled filter name is not applied — the response returns 200 with a broader result set than you intended, and nothing marks the difference. Where a request body declares `additionalProperties: false`, strict client-side validation is what catches that. Fields sent with the wrong type are rejected with 400 on most endpoints; validate types in your client too rather than relying on it.

    Rate limits: each resource (for example awards, opportunities, or workspaces) allows 70 requests per minute per user. Exceeding it returns 429 with the standard error envelope, `code: rate_limited`, and a `Retry-After` header. Keys sent in the `X-API-KEY` header are also subject to the Enterprise API limit of 300 requests per minute per key; see the Rate Limits page.'
servers:
- url: https://app.govly.com
security:
- bearerApiKey: []
- headerApiKey: []
tags:
- name: Signals
  description: Search clustered procurement and market intelligence signals.
paths:
  /api/tools/v1/signals/{id}:
    get:
      tags:
      - Signals
      operationId: show_signal
      summary: Show a signal cluster
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Govly signal-cluster database ID.
      responses:
        '200':
          description: Signal cluster detail
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/SignalDetail'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
  /api/tools/v1/signals/search:
    post:
      tags:
      - Signals
      operationId: search_signals
      summary: Search signals
      description: Search clustered procurement and market signals (news, hearings, laws, events, analysis, policy, regulatory actions, and public meetings) with the constrained public parameter set shared by MCP search_signals. query is a fuzzy, semantic search; contentTypes, categories, and dateRange are exact filters AND-combined with query. categories is a hard filter on curated slugs and only matches tagged clusters. Paginate with cursor; a request carrying a page number is rejected with 400. meta.aggregations returns facet counts on the first page only.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                query:
                  type: string
                  maxLength: 500
                  description: Fuzzy + semantic search text over signal content.
                cursor:
                  type: string
                  description: Opaque cursor from the previous response's meta.nextCursor. Omit for the first page.
                perPage:
                  type: integer
                  default: 25
                  description: Results per page. Default 25, maximum 100.
                contentTypes:
                  type: array
                  items:
                    type: string
                    enum:
                    - news
                    - hearing
                    - law
                    - event
                    - analysis
                    - policy
                    - regulatory
                    - meeting
                  description: Exact filter — only clusters containing signals of these content types.
                categories:
                  type: array
                  items:
                    type: string
                    enum:
                    - regulatory_policy
                    - cybersecurity
                    - defense
                    - technology_digital
                    - infrastructure
                    - healthcare_services
                    - business_compliance
                  description: 'Exact hard filter on curated category slugs. Narrows to tagged clusters; may miss differently-tagged signals. Use for explicit narrowing, not for topics that belong in query.

                    '
                dateRange:
                  type: array
                  items:
                    type:
                    - string
                    - 'null'
                  maxItems: 2
                  description: Filter by signal date as [start, end] in ISO 8601 format. Use null for an open-ended bound (e.g. [null, end]). Omit or pass an empty array for no date filter.
      responses:
        '200':
          description: Matching signal clusters
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Signal'
                  meta:
                    $ref: '#/components/schemas/SignalSearchMeta'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    SignalSource:
      type: object
      required:
      - id
      properties:
        id:
          type: string
        url:
          type: string
        sourceName:
          type: string
        title:
          type: string
        executiveSummary:
          type: string
        contentType:
          type: string
        jurisdiction:
          type: string
        flowName:
          type: string
        collectionMethod:
          type: string
        publishedAt:
          type: string
          format: date-time
    RateLimitError:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    SignalSearchMeta:
      type: object
      description: Cursor pagination metadata for signal search.
      required:
      - total
      - perPage
      properties:
        total:
          type: integer
          description: 'Total matching clusters, capped at 10,000 by the search engine. Pagination via nextCursor is not limited by this cap.

            '
        perPage:
          type: integer
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass into the next request's cursor; null when the results are exhausted.
        query:
          type:
          - string
          - 'null'
        aggregations:
          $ref: '#/components/schemas/SignalSearchAggregations'
    ErrorEnvelope:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
            - status
            - code
            - title
            - detail
            properties:
              status:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
    Signal:
      type: object
      description: 'A procurement signal cluster — a group of related signals (news, events, meetings, ...) about the same topic. Empty and null fields are omitted.

        '
      required:
      - id
      properties:
        tagLabels:
          type: array
          description: Display labels flattened from the signal cluster tags.
          items:
            type: string
        id:
          type: string
        name:
          type: string
        executiveSummary:
          type: string
        firstPublishedAt:
          type: string
          format: date-time
        latestPublishedAt:
          type: string
          format: date-time
        contentTypes:
          type: array
          items:
            type: string
          description: Distinct content types of the signals in this cluster.
        signalCount:
          type: integer
        jurisdictions:
          type: array
          items:
            type: string
        industryTags:
          type: array
          items:
            type: string
        topicTags:
          type: array
          items:
            type: string
        categories:
          type: array
          items:
            type: string
          description: Curated category slugs computed from the cluster's tags.
        sourceNames:
          type: array
          items:
            type: string
        signalUrl:
          type: string
          deprecated: true
          description: Deprecated alias of links.self. Retained for Tools API v1 compatibility.
        links:
          type: object
          description: Canonical links for this signal cluster. Source-system links belong to individual source records.
          required:
          - self
          properties:
            self:
              type: string
              format: uri
              description: Canonical Govly app link for this signal.
        vendors:
          type: array
          items:
            type: object
        governmentEntities:
          type: array
          items:
            type: object
        contacts:
          type: array
          items:
            type: object
        eventStartDate:
          type: string
          description: Present only for clusters containing an event signal.
        bodyName:
          type: string
          description: Meeting body name; present only for clusters containing a meeting signal.
    SignalSearchAggregations:
      type: object
      description: 'Facet counts returned on the first page only, covering the filter dimensions (`categories`, `contentTypes`) plus `jurisdictions`, which is discovery-only and has no filter input. Each entry is an array of { value, count } objects. Facets are computed from the indexed snapshot and can lag the result fields (which reflect current data), so counts may differ from what is in `data`.

        '
      properties:
        categories:
          type: array
          items:
            type: object
        contentTypes:
          type: array
          items:
            type: object
        jurisdictions:
          type: array
          items:
            type: object
    SignalDetail:
      allOf:
      - $ref: '#/components/schemas/Signal'
      - type: object
        required:
        - signals
        properties:
          signals:
            type: array
            description: Source records in this signal cluster. Transcript, media, attachment, and raw enrichment fields are excluded.
            items:
              $ref: '#/components/schemas/SignalSource'
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: 'Too many requests. Two limiters can produce this status and they use different bodies. The per-user limit of 70 requests per minute for each resource returns the standard error envelope with `code: rate_limited` and a `Retry-After` header. Keys sent in the `X-API-KEY` header are also subject to the Enterprise API limit of 300 requests per minute per key, which returns the plain `error` form with `Retry-After` and the `X-RateLimit-*` headers. Clients should accept either body.

        '
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: string
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - $ref: '#/components/schemas/RateLimitError'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: API key
    headerApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
x-provenance:
  method: harvested
  publisher: Govly
  source: https://docs.govly.com/openapi/tools-v1.yaml
  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)