Events.com Workbook Agent API

openapi: 3.2.0
info:
  title: DataGol AI Workbook Agent API
  version: 1.0.36
tags:
- name: Workbook Agent
paths:
  /ai/api/v2/messages:
    post:
      tags:
      - Workbook Agent
      summary: Send Message To Agent
      operationId: send_message_to_agent_ai_api_v2_messages_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - additionalProperties: true
                  type: object
                - type: string
                title: Response Send Message To Agent Ai Api V2 Messages Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/messages/{conversation_id}/{message_id}/stop:
    post:
      tags:
      - Workbook Agent
      summary: Stop Streaming Agent Run
      operationId: stop_streaming_agent_run_ai_api_v2_messages__conversation_id___message_id__stop_post
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          title: Conversation Id
      - name: message_id
        in: path
        required: true
        schema:
          type: string
          title: Message Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Stop Streaming Agent Run Ai Api V2 Messages  Conversation Id   Message
                  Id  Stop Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/messages/streaming:
    post:
      tags:
      - Workbook Agent
      summary: Send Message To Streaming Agent
      operationId: send_message_to_streaming_agent_ai_api_v2_messages_streaming_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - additionalProperties: true
                  type: object
                - type: string
                title: Response Send Message To Streaming Agent Ai Api V2 Messages Streaming Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/messages/streaming/{conversation_id}/{message_id}:
    get:
      tags:
      - Workbook Agent
      summary: Stream Message Events
      description: 'SSE endpoint: stream agent response chunks for the given message in a conversation.

        Client must pass the message_id returned by POST /messages/streaming to avoid races

        with "latest message" lookups.'
      operationId: stream_message_events_ai_api_v2_messages_streaming__conversation_id___message_id__get
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          title: Conversation Id
      - name: message_id
        in: path
        required: true
        schema:
          type: integer
          title: Message Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/runs/active:
    get:
      tags:
      - Workbook Agent
      summary: List Active Runs
      operationId: list_active_runs_ai_api_v2_runs_active_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /ai/api/v2/mcp/tools:
    post:
      tags:
      - Workbook Agent
      summary: List Mcp Tools
      description: 'List all tools available from an MCP server configuration.


        Accepts the MCP config DTO directly in the request body.'
      operationId: list_mcp_tools_ai_api_v2_mcp_tools_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    AgentRequest:
      properties:
        userId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Userid
          description: 'ID of the user sending this query. '
        conversationId:
          type: string
          title: Conversationid
          description: Conversation or thread ID of the query.
        message:
          type: string
          title: Message
          description: User query or message to the agent.
        selectedLlmModel:
          anyOf:
          - type: string
          - type: 'null'
          title: Selectedllmmodel
          description: Model to be used to resolve the query.
        parameters:
          $ref: '#/components/schemas/Parameters'
          description: Context for the query
        agentType:
          type: string
          title: Agenttype
          description: 'Type of agent. Example: PythonAgent, DataConversationAgent, SQLAgent, BIAgent,
            etc.'
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
          description: Alias for agentType sent by some UI clients.
        selectedParser:
          type: string
          title: Selectedparser
          description: 'Type of parser. Example: LLM Sherpa, Llama Parse'
        workbookIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Workbookids
          description: List of workbook IDs for additional data sources.
        uiMetadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Uimetadata
          description: Optional UI metadata persisted on the message row and returned when loading messages.
        enableStreamPersistence:
          type: boolean
          title: Enablestreampersistence
          description: When True, chunks are persisted to Redis and the POST response is a JSON status
            object; clients must connect to GET /messages/streaming/{conversationId}. When False (default),
            chunks are streamed inline on the POST response.
          default: false
      type: object
      required:
      - message
      - parameters
      - agentType
      title: AgentRequest
    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
    Parameters:
      properties:
        dataProvider:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataprovider
          description: Provider if that is the context.
        viewId:
          anyOf:
          - type: string
          - type: 'null'
          title: Viewid
          description: View ID if that is the context.
        workbookId:
          anyOf:
          - type: string
          - type: 'null'
          title: Workbookid
          description: Workbook ID if that is the context.
        workspaceId:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspaceid
          description: Workspace ID if that is the context.
        dataSourceId:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Datasourceid
          description: List of Datasource IDs if that is the context.
        dataSourceIds:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Datasourceids
          description: List of Datasource IDs if that is the context.
        tableId:
          anyOf:
          - type: string
          - type: 'null'
          title: Tableid
          description: Table/Workbook ID if that is the context. BI Agent specific.
        fileId:
          anyOf:
          - type: string
          - type: 'null'
          title: Fileid
          description: File ID for knowledge graph agent.
        schemaJson:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Schemajson
          description: Schema of the data source.
        dialect:
          anyOf:
          - type: string
          - type: 'null'
          title: Dialect
          description: 'Dialect of the query. Example: JDBC, SPARK, etc.'
        toolsSelected:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Toolsselected
          description: List of tools selected by the user.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Error message if any.
        fileIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Fileids
          description: File IDs if that is the context.
        folderIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Folderids
          description: Complete hierarchy of the folder name.
        connectorId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Connectorid
          description: Connector ID of the Jira connector.
        customAgentId:
          anyOf:
          - type: string
          - type: 'null'
          title: Customagentid
          description: Custom Agent ID.
        sqlQuery:
          anyOf:
          - type: string
          - type: 'null'
          title: Sqlquery
          description: SQL query for generating a workbook
        enableBiHistory:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enablebihistory
          description: Enable BI history for the query.
          default: true
        selectedLlmModels:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Selectedllmmodels
          description: Map of selected llm models.
        chainId:
          anyOf:
          - type: string
          - type: 'null'
          title: Chainid
          description: Chain ID of the query.
        image:
          anyOf:
          - type: string
          - type: 'null'
          title: Image
          description: plolty chart Image.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Python code to execute. If provided, no planning/code generation will be done.
        workbookIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Workbookids
          description: Selected workbooks in the same workspace as workbookId; first item duplicates workbookId
            (primary); remaining IDs are auxiliary.
        autoApprove:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Autoapprove
          description: When True or omitted, agent does not prompt for plan/code confirmation and proceeds
            automatically. When False, requires user confirmation.
        analysisLevel:
          anyOf:
          - type: string
          - type: 'null'
          title: Analysislevel
          description: 'LLM profile: "FAST", "MODERATE", or "DEEP_ANALYSIS".'
        collections:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Collections
          description: List of collections to query.
        pageId:
          anyOf:
          - type: string
          - type: 'null'
          title: Pageid
          description: Page ID of the query.
        sessionId:
          anyOf:
          - type: string
          - type: 'null'
          title: Sessionid
          description: Session ID for the browser operator.
        properties:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Properties
          description: Custom properties.
        conversationFileIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Conversationfileids
          description: List of conversation file IDs.
      type: object
      title: Parameters
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError