Altimate AI WORKFLOW_DASHBOARD API

The WORKFLOW_DASHBOARD API from Altimate AI — 16 operation(s) for workflow_dashboard.

OpenAPI Specification

altimate-ai-workflow-dashboard-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS WORKFLOW_DASHBOARD API
  version: 0.1.0
tags:
- name: WORKFLOW_DASHBOARD
paths:
  /api/v1/workflow/dashboard/agents:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Get Agents
      operationId: get_agents_api_v1_workflow_dashboard_agents_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: enabled_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Enabled Only
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Create New Agent
      operationId: create_new_agent_api_v1_workflow_dashboard_agents_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/agents/{agent_id}:
    put:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Update Existing Agent
      operationId: update_existing_agent_api_v1_workflow_dashboard_agents__agent_id__put
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/agents/seed:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Seed Agents
      description: Upsert the canonical agent roster from altimate-workflow-agents.
      operationId: seed_agents_api_v1_workflow_dashboard_agents_seed_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /api/v1/workflow/dashboard/sessions:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Get Sessions
      operationId: get_sessions_api_v1_workflow_dashboard_sessions_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: status_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status Filter
      - name: include_archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Archived
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Create New Session
      operationId: create_new_session_api_v1_workflow_dashboard_sessions_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/sessions/{session_id}:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Get Session Detail
      operationId: get_session_detail_api_v1_workflow_dashboard_sessions__session_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Update Existing Session
      operationId: update_existing_session_api_v1_workflow_dashboard_sessions__session_id__put
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/sessions/{session_id}/transition:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Transition Existing Session
      operationId: transition_existing_session_api_v1_workflow_dashboard_sessions__session_id__transition_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionTransitionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/sessions/{session_id}/archive:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Archive Existing Session
      operationId: archive_existing_session_api_v1_workflow_dashboard_sessions__session_id__archive_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/sessions/{session_id}/unarchive:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Unarchive Existing Session
      operationId: unarchive_existing_session_api_v1_workflow_dashboard_sessions__session_id__unarchive_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/sessions/{session_id}/messages:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Send Message
      description: 'Dashboard user sends a message to a session.


        Also creates a send-message command so the sidecar can relay to Slack/channel.'
      operationId: send_message_api_v1_workflow_dashboard_sessions__session_id__messages_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardMessageRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/cron:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Get Cron Jobs
      operationId: get_cron_jobs_api_v1_workflow_dashboard_cron_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: enabled_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Enabled Only
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/commands:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Send Command
      operationId: send_command_api_v1_workflow_dashboard_commands_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommandCreateRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /api/v1/workflow/dashboard/commands/{command_id}/cancel:
    post:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Cancel Pending Command
      operationId: cancel_pending_command_api_v1_workflow_dashboard_commands__command_id__cancel_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: command_id
        in: path
        required: true
        schema:
          type: string
          title: Command Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/config:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: List Configs
      description: List all config entries, optionally filtered by namespace.
      operationId: list_configs_api_v1_workflow_dashboard_config_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: namespace
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Set Config
      operationId: set_config_api_v1_workflow_dashboard_config_put
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigUpsertRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/config/{config_id}:
    delete:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Delete Config Entry
      description: Delete a config entry by ID.
      operationId: delete_config_entry_api_v1_workflow_dashboard_config__config_id__delete
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: string
          title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workflow/dashboard/status:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Get Overview Status
      description: High-level status for the command center header.
      operationId: get_overview_status_api_v1_workflow_dashboard_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /api/v1/workflow/dashboard/sessions/{session_id}/stream:
    get:
      tags:
      - WORKFLOW_DASHBOARD
      summary: Stream Session Messages
      description: "SSE stream for real-time message updates on a session.\n\n    Sends new messages as they appear. Client connects once and receives\n    events as `data: {json}\n\n` lines."
      operationId: stream_session_messages_api_v1_workflow_dashboard_sessions__session_id__stream_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommandCreateRequest:
      properties:
        command:
          type: string
          title: Command
        payload:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Payload
      type: object
      required:
      - command
      title: CommandCreateRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ConfigUpsertRequest:
      properties:
        namespace:
          type: string
          title: Namespace
        key:
          type: string
          title: Key
        value:
          title: Value
        encrypted:
          type: boolean
          title: Encrypted
          default: false
      type: object
      required:
      - namespace
      - key
      - value
      title: ConfigUpsertRequest
    SessionCreateRequest:
      properties:
        title:
          type: string
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        channel:
          anyOf:
          - type: string
          - type: 'null'
          title: Channel
        priority:
          anyOf:
          - type: string
          - type: 'null'
          title: Priority
          default: medium
        agent_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Type
      type: object
      required:
      - title
      title: SessionCreateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SessionTransitionRequest:
      properties:
        status:
          type: string
          title: Status
      type: object
      required:
      - status
      title: SessionTransitionRequest
    SessionUpdateRequest:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        priority:
          anyOf:
          - type: string
          - type: 'null'
          title: Priority
        current_agent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Agent Id
        assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: Assignee
        next_action:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Action
      type: object
      title: SessionUpdateRequest
    AgentCreateRequest:
      properties:
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        model_config_:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Model Config
        tools:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tools
        enabled:
          type: boolean
          title: Enabled
          default: true
      type: object
      required:
      - name
      - slug
      title: AgentCreateRequest
    AgentUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Slug
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        model_config_:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Model Config
        tools:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tools
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
      type: object
      title: AgentUpdateRequest
    DashboardMessageRequest:
      properties:
        content:
          type: string
          title: Content
        role:
          type: string
          title: Role
          default: user
      type: object
      required:
      - content
      title: DashboardMessageRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer