hyreflow-ai Knowledge API

The Knowledge API from hyreflow-ai — 4 operation(s) for knowledge.

GitHub OpenAPI

Operations 5

GET /api/v2/knowledge/index Knowledge Index #
GET /api/v2/knowledge/search Knowledge Search #
GET /api/v2/knowledge/pages/{slug} Knowledge Page #
GET /api/v2/knowledge/build Knowledge Build #
POST /api/v2/knowledge/build Knowledge Build Start #

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/hyreflow-ai:hyreflow-ai-knowledge-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

hyreflow-ai-knowledge-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: hyreflow engine (local) Knowledge API
  version: 0.1.0
tags:
- name: Knowledge
paths:
  /api/v2/knowledge/index:
    get:
      summary: Knowledge Index
      description: Every page without its body.
      operationId: knowledge_index_api_v2_knowledge_index_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Knowledge
  /api/v2/knowledge/search:
    get:
      summary: Knowledge Search
      description: 'Ranked pages for a web-search style `q`: "quoted phrases", `or`, -exclude. `archived` includes archived pages.'
      operationId: knowledge_search_api_v2_knowledge_search_get
      security:
      - HTTPBearer: []
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          title: Q
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      - name: archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Archived
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Knowledge
  /api/v2/knowledge/pages/{slug}:
    get:
      summary: Knowledge Page
      description: 'One page: `view=body` is the text, `view=full` adds data, sources, links and backlinks.'
      operationId: knowledge_page_api_v2_knowledge_pages__slug__get
      security:
      - HTTPBearer: []
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: view
        in: query
        required: false
        schema:
          type: string
          default: body
          title: View
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Knowledge
  /api/v2/knowledge/build:
    get:
      summary: Knowledge Build
      description: 'Page count, the latest build run, `can_start` (this caller, the owner, may start one now),

        `needs_website` (they could, once they give a company website: a personal email and none saved) and

        `limit` ("owner": they built in another workspace of theirs, "daily": today''s builds are used up).'
      operationId: knowledge_build_api_v2_knowledge_build_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Knowledge
    post:
      summary: Knowledge Build Start
      description: 'Start the build now, for an owner whose workspace has none (workspaces that were already onboarded).

        `website` (optional) is saved as the workspace''s website first, and the build reads it: how an owner who

        signed in with a personal email gets one. Same guards as the onboarding trigger: one build per

        workspace, house-paid.'
      operationId: knowledge_build_start_api_v2_knowledge_build_post
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: true
              type: object
              title: Body
              default: {}
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      tags:
      - Knowledge
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer