hyreflow-ai Workspace API

The Workspace API from hyreflow-ai — 10 operation(s) for workspace.

GitHub OpenAPI

Operations 18

GET /api/v2/workspace Workspace Info #
GET /api/v2/workspace/desk-defaults Desk Defaults Get #
PUT /api/v2/workspace/desk-defaults Desk Defaults Put #
GET /api/v2/workspace/invites Workspace List Invites #
POST /api/v2/workspace/invites Workspace Create Invite #
GET /api/v2/workspace/skills Skills List #
POST /api/v2/workspace/skills Skills Create #
GET /api/v2/workspace/skills/{skill_id} Skills Get #
PUT /api/v2/workspace/skills/{skill_id} Skills Update #
DELETE /api/v2/workspace/skills/{skill_id} Skills Delete #
POST /api/v2/workspace/skills/{skill_id}/versions/{version}/{decision} Skills Review #
GET /api/v2/workspace/linkedin-connections Linkedin Connections Status #
POST /api/v2/workspace/linkedin-connections Linkedin Connections Upload #
PATCH /api/v2/workspace/linkedin-connections Linkedin Connections Settings #
DELETE /api/v2/workspace/linkedin-connections Linkedin Connections Delete #
GET /api/v2/workspace/access-requests Workspace List Access Requests #
POST /api/v2/workspace/access-requests/{request_id}/approve Workspace Approve Access Request #
POST /api/v2/workspace/access-requests/{request_id}/dismiss Workspace Dismiss Access Request #

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-workspace-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-workspace-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: hyreflow engine (local) Workspace API
  version: 0.1.0
tags:
- name: Workspace
paths:
  /api/v2/workspace:
    get:
      summary: Workspace Info
      description: 'The caller''s ACTIVE workspace (name, members, balance). `workspace_id` is null for owner-less

        implicit accounts (dev/CI + anonymous) — not surfaced as real workspaces.'
      operationId: workspace_info_api_v2_workspace_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Workspace
  /api/v2/workspace/desk-defaults:
    get:
      summary: Desk Defaults Get
      description: The workspace's saved search defaults for the prompt builder. Any member can read them.
      operationId: desk_defaults_get_api_v2_workspace_desk_defaults_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Workspace
    put:
      summary: Desk Defaults Put
      description: Replace the workspace's saved search defaults. Owner only.
      operationId: desk_defaults_put_api_v2_workspace_desk_defaults_put
      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:
      - Workspace
  /api/v2/workspace/invites:
    get:
      summary: Workspace List Invites
      description: List all invites for the active workspace. `seat_available` is retained as true for clients.
      operationId: workspace_list_invites_api_v2_workspace_invites_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Workspace
    post:
      summary: Workspace Create Invite
      description: 'Create or resend an invite for the caller''s active workspace. Sends an email with the invite link

        (best-effort via Resend; logs the link in dev mode). Owner-only. Invitees join as `member`: they can

        use the workspace, but billing, the team and integrations are the owner''s.

        Optional `spend_cap_usd` pre-sets the member''s rolling-30d cap at accept time — owner only.'
      operationId: workspace_create_invite_api_v2_workspace_invites_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:
      - Workspace
  /api/v2/workspace/skills:
    get:
      summary: Skills List
      description: 'Every custom skill the caller can see: their personal ones and the workspace''s team ones, and

        `trial_expires_at`: when a free workspace''s agent loses them over MCP, null when it never does.'
      operationId: skills_list_api_v2_workspace_skills_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Workspace
    post:
      summary: Skills Create
      description: 'Create a skill from `{scope: "personal"|"org", files: {path: text}}`.'
      operationId: skills_create_api_v2_workspace_skills_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:
      - Workspace
  /api/v2/workspace/skills/{skill_id}:
    get:
      summary: Skills Get
      description: 'One skill with its files at `version` (default: the live one) and its version history.'
      operationId: skills_get_api_v2_workspace_skills__skill_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: skill_id
        in: path
        required: true
        schema:
          type: string
          title: Skill Id
      - name: version
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
    put:
      summary: Skills Update
      description: 'Save a new version from `{files: {path: text}}`. A team version waits for the owner.'
      operationId: skills_update_api_v2_workspace_skills__skill_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: skill_id
        in: path
        required: true
        schema:
          type: string
          title: Skill Id
      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:
      - Workspace
    delete:
      summary: Skills Delete
      operationId: skills_delete_api_v2_workspace_skills__skill_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: skill_id
        in: path
        required: true
        schema:
          type: string
          title: Skill Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
  /api/v2/workspace/skills/{skill_id}/versions/{version}/{decision}:
    post:
      summary: Skills Review
      description: Owner approves or rejects a pending team version, with an optional `{note}`.
      operationId: skills_review_api_v2_workspace_skills__skill_id__versions__version___decision__post
      security:
      - HTTPBearer: []
      parameters:
      - name: skill_id
        in: path
        required: true
        schema:
          type: string
          title: Skill Id
      - name: version
        in: path
        required: true
        schema:
          type: integer
          title: Version
      - name: decision
        in: path
        required: true
        schema:
          type: string
          title: Decision
      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:
      - Workspace
  /api/v2/workspace/linkedin-connections:
    get:
      summary: Linkedin Connections Status
      description: Who in the workspace has uploaded their LinkedIn connections, when, and how many.
      operationId: linkedin_connections_status_api_v2_workspace_linkedin_connections_get
      security:
      - HTTPBearer: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Workspace
    post:
      summary: Linkedin Connections Upload
      description: 'Upload (or re-upload) the caller''s Connections.csv, sent as the raw request body. Replaces

        their previous upload whole. `?reminders=true|false` is the 30-day reminder box on the upload page;

        absent keeps the stored choice.'
      operationId: linkedin_connections_upload_api_v2_workspace_linkedin_connections_post
      security:
      - HTTPBearer: []
      parameters:
      - name: reminders
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Reminders
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
    patch:
      summary: Linkedin Connections Settings
      description: '`{"reminders": bool}`: turn the caller''s 30-day upload reminder on or off. Never plan-gated.'
      operationId: linkedin_connections_settings_api_v2_workspace_linkedin_connections_patch
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
    delete:
      summary: Linkedin Connections Delete
      description: 'Remove the caller''s uploaded connections. Never plan-gated: a downgraded member can always

        take their own data out.'
      operationId: linkedin_connections_delete_api_v2_workspace_linkedin_connections_delete
      security:
      - HTTPBearer: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Workspace
  /api/v2/workspace/access-requests:
    get:
      summary: Workspace List Access Requests
      description: Pending domain access requests (ENG-699) for the active workspace. Owner only.
      operationId: workspace_list_access_requests_api_v2_workspace_access_requests_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      tags:
      - Workspace
  /api/v2/workspace/access-requests/{request_id}/approve:
    post:
      summary: Workspace Approve Access Request
      description: 'In-app approve: closes the request and sends the same invite the email link does.'
      operationId: workspace_approve_access_request_api_v2_workspace_access_requests__request_id__approve_post
      security:
      - HTTPBearer: []
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
  /api/v2/workspace/access-requests/{request_id}/dismiss:
    post:
      summary: Workspace Dismiss Access Request
      description: 'Dismiss without inviting. The requester is emailed, sees the workspace choice again on their next

        sign-in, and can''t ask this workspace again for DISMISS_COOLDOWN_DAYS.'
      operationId: workspace_dismiss_access_request_api_v2_workspace_access_requests__request_id__dismiss_post
      security:
      - HTTPBearer: []
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Workspace
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