Rulebase

Rulebase Session API

The Session API from Rulebase — 8 operation(s) for session.

GitHub OpenAPI

Operations 10

POST /session/organization Create session organization #
GET /session/activity Get session activity #
POST /session/activity Create session activity #
GET /session/account Get session account #
GET /session Get session #
PUT /session/experience Replace session experience #
PUT /session/homepage Replace session homepage #
PUT /session/sidebar-teams Replace session sidebar teams #
GET /session/notifications/call-summaries Get session notifications call summaries #
PUT /session/notifications/call-summaries Replace session notifications call summaries #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-session-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

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/rulebase:rulebase-session-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.

GitHub Google LinkedIn

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

OpenAPI Specification

rulebase-session-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Session API
  version: 0.0.1
tags:
- name: Session
paths:
  /session/organization:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                organization_id:
                  type: string
                  minLength: 1
                  maxLength: 255
              required:
              - organization_id
      responses:
        '204':
          description: Organization selected and session cookie renewed
        '401':
          description: Sign in again
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Untrusted origin or organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Organization authentication temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Create session organization
      x-summary-source: derived
      operationId: postSessionOrganization
      x-operation-id-source: derived
  /session/activity:
    get:
      responses:
        '200':
          description: Current session expiry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionActivity'
        '401':
          description: Sign in again
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Get session activity
      x-summary-source: derived
      operationId: getSessionActivity
      x-operation-id-source: derived
    post:
      responses:
        '200':
          description: Current session expiry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionActivity'
        '401':
          description: Sign in again
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Untrusted origin
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Create session activity
      x-summary-source: derived
      operationId: postSessionActivity
      x-operation-id-source: derived
  /session/account:
    get:
      responses:
        '200':
          description: Signed-in account, with or without an active organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  account_id:
                    type: string
                  organization_id:
                    type: string
                    nullable: true
                  account:
                    type: object
                    properties:
                      id:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                    required:
                    - id
                    - full_name
                    - email
                required:
                - account_id
                - organization_id
                - account
        '401':
          description: Sign in again
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Get session account
      x-summary-source: derived
      operationId: getSessionAccount
      x-operation-id-source: derived
  /session:
    get:
      responses:
        '200':
          description: Current authenticated session
          content:
            application/json:
              schema:
                type: object
                properties:
                  account_id:
                    type: string
                  organization_id:
                    type: string
                    nullable: true
                  organization_internal_id:
                    type: number
                    nullable: true
                  account:
                    type: object
                    properties:
                      id:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                    required:
                    - id
                    - full_name
                    - email
                  membership:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                      role:
                        type: object
                        properties:
                          id:
                            type: string
                          permissions:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                              required:
                              - id
                        required:
                        - id
                        - permissions
                      employee:
                        nullable: true
                    required:
                    - id
                    - role
                  accountId:
                    type: string
                  email:
                    type: string
                  organizationSlug:
                    type: string
                  userId:
                    type: string
                  organizationId:
                    type: string
                  membershipId:
                    type: string
                  permissions:
                    type: array
                    items:
                      type: string
                  homepageDashboardId:
                    type: string
                    nullable: true
                  homepagePage:
                    type: string
                    nullable: true
                    enum:
                    - performance
                    - performance_my_teams
                  homepageTeamId:
                    type: string
                    nullable: true
                  sidebarTeamIds:
                    type: array
                    nullable: true
                    items:
                      type: string
                  lastExperience:
                    type: string
                    enum:
                    - human_qa
                    - agent_monitoring
                required:
                - account_id
                - organization_id
                - organization_internal_id
                - account
                - membership
                - accountId
                - email
                - organizationSlug
                - userId
                - organizationId
                - membershipId
                - permissions
                - homepageDashboardId
                - homepagePage
                - homepageTeamId
                - sidebarTeamIds
                - lastExperience
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Get session
      x-summary-source: derived
      operationId: getSession
      x-operation-id-source: derived
  /session/experience:
    put:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                experience:
                  type: string
                  enum:
                  - human_qa
                  - agent_monitoring
              required:
              - experience
      responses:
        '200':
          description: Last app experience updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  experience:
                    type: string
                    enum:
                    - human_qa
                    - agent_monitoring
                required:
                - experience
        '404':
          description: Membership not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Replace session experience
      x-summary-source: derived
      operationId: putSessionExperience
      x-operation-id-source: derived
  /session/homepage:
    put:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: string
                  nullable: true
                  enum:
                  - performance
                  - performance_my_teams
                team_id:
                  type: string
                  nullable: true
              required:
              - page
              - team_id
      responses:
        '200':
          description: Homepage updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  homepagePage:
                    type: string
                    nullable: true
                    enum:
                    - performance
                    - performance_my_teams
                  homepageTeamId:
                    type: string
                    nullable: true
                required:
                - homepagePage
                - homepageTeamId
        '404':
          description: Team or membership not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Replace session homepage
      x-summary-source: derived
      operationId: putSessionHomepage
      x-operation-id-source: derived
  /session/sidebar-teams:
    put:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                team_ids:
                  type: array
                  items:
                    type: string
                  maxItems: 100
              required:
              - team_ids
      responses:
        '200':
          description: Sidebar teams updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  sidebarTeamIds:
                    type: array
                    items:
                      type: string
                required:
                - sidebarTeamIds
        '404':
          description: Team or membership not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Session
      summary: Replace session sidebar teams
      x-summary-source: derived
      operationId: putSessionSidebarTeams
      x-operation-id-source: derived
  /session/notifications/call-summaries:
    get:
      responses:
        '200':
          description: Current member's post-call summary preference
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                required:
                - enabled
      tags:
      - Session
      summary: Get session notifications call summaries
      x-summary-source: derived
      operationId: getSessionNotificationsCallSummaries
      x-operation-id-source: derived
    put:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
      responses:
        '200':
          description: Post-call summary preference updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                required:
                - enabled
      tags:
      - Session
      summary: Replace session notifications call summaries
      x-summary-source: derived
      operationId: putSessionNotificationsCallSummaries
      x-operation-id-source: derived
components:
  schemas:
    SessionActivity:
      type: object
      properties:
        last_activity_at:
          type: string
          format: date-time
        idle_expires_at:
          type: string
          format: date-time
        absolute_expires_at:
          type: string
          format: date-time
        inactivity_timeout_minutes:
          type: integer
        server_time:
          type: string
          format: date-time
      required:
      - last_activity_at
      - idle_expires_at
      - absolute_expires_at
      - inactivity_timeout_minutes
      - server_time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key