hyreflow-ai Session API

The Session API from hyreflow-ai — 9 operation(s) for session.

GitHub OpenAPI

Operations 9

POST /session/start Session Start #
POST /session/update Session Update #
POST /session/status Session Status #
POST /session/output Session Output #
POST /session/{sid}/alert Session Alert #
POST /session/{sid}/limit Session Limit #
POST /session/{sid}/end Session End #
POST /session/{sid}/feedback Session Feedback #
GET /session/{sid} Session Get #

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-session-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-session-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: hyreflow engine (local) Session API
  version: 0.1.0
tags:
- name: Session
paths:
  /session/start:
    post:
      summary: Session Start
      operationId: session_start_session_start_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:
      - Session
  /session/update:
    post:
      summary: Session Update
      operationId: session_update_session_update_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:
      - Session
  /session/status:
    post:
      summary: Session Status
      operationId: session_status_session_status_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:
      - Session
  /session/output:
    post:
      summary: Session Output
      operationId: session_output_session_output_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:
      - Session
  /session/{sid}/alert:
    post:
      summary: Session Alert
      description: 'Raise (or clear, when `message` is null/empty) the Playground approval banner. The human answer

        is given in the CLI — this only signals ''check your terminal''.'
      operationId: session_alert_session__sid__alert_post
      security:
      - HTTPBearer: []
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          title: Sid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              default: {}
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Session
  /session/{sid}/limit:
    post:
      summary: Session Limit
      description: 'Set (or clear, when `usd` is null) the per-session dollar spend cap. Enforced pre-flight. The

        owner''s workspace default (PUT /api/v2/billing/session-cap) is a member''s ceiling: they may tighten a

        session, never raise it past the default or clear it.'
      operationId: session_limit_session__sid__limit_post
      security:
      - HTTPBearer: []
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          title: Sid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              default: {}
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Session
  /session/{sid}/end:
    post:
      summary: Session End
      description: 'Close a session (idempotent). After this, new runs carrying the session id — whether in

        body.session_id or the X-Hyreflow-Session-Id header — no longer accrue to it (ENG-240), so a stale

        stored session can''t keep billing the spent pill / burning its cap after the live run is over.'
      operationId: session_end_session__sid__end_post
      security:
      - HTTPBearer: []
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          title: Sid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Session
  /session/{sid}/feedback:
    post:
      summary: Session Feedback
      description: 'Store feedback (unified with the other two ingest paths — one `feedback` row, not a separate

        session_feedback table) and file a Linear issue (best-effort) so the team can triage it.'
      operationId: session_feedback_session__sid__feedback_post
      security:
      - HTTPBearer: []
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          title: Sid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              default: {}
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Session
  /session/{sid}:
    get:
      summary: Session Get
      operationId: session_get_session__sid__get
      security:
      - HTTPBearer: []
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          title: Sid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Session
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