Tech Journeyman

Tech Journeyman · GPT Actions

Origamist

ChatGPT Plugin server for creating computational notebooks (in Python!), allowing you to execute code, explore data, and visualize results.

  • GET /api/origami/about/About

    About the plugin and runtime environment.

  • PUT /api/origami/p/defaultSet Default Project

    Configure the user's default project.

  • GET /api/origami/p/file_listGet Default Project Files

    Get a list of files in the user's default Project. Optionally filter by space-delimited list of file extensions and/or filename fuzzy match.

  • GET /api/origami/p/file_list/{project_id}Get Project Files

    Get a list of files in a specific Project. Optionally filter by space-delimited list of file extensions and/or filename fuzzy match.

  • GET /api/origami/p/kernel_listGet Default Project Kernels

    Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in the user's default Project.

  • GET /api/origami/p/kernel_list/{project_id}Get Project Kernels

    Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in a specific Project.

  • POST /api/origami/f/Create Notebook

    Creates a new notebook. If no project ID is provided, the user's default project will be used.

  • GET /api/origami/f/{file_id}Get Content

    Get the content of a Notebook or other file type. The after_cell_id optional parameter is for retrieving partial content of a Notebook if the full Notebook content gets truncated

  • GET /api/origami/f/metadata/{file_id}Get File Metadata

    Get metadata about a file including its file id, filepath, and the project id it is in. Important! Notebooks can only read in files located in the same project, specify the project_id on Notebook creation if working with this file.

  • GET /api/origami/f/{file_id}/datasourcesGet Datasources

    Get the databases for a notebook file by UUID.

  • POST /api/origami/f/{file_id}/run_cellsRun Multiple Cells

    Execute an individual cell_id, run all cells in the Notebook, or run all before / after a cell

  • GET /api/origami/f/{file_id}/c/{cell_id}Get Cell

    Return Cell model details

  • POST /api/origami/f/{file_id}/c/{cell_id}Change Cell Type

    Endpoint to allow updating the type of a cell. Currently only supports changing between Code, Markdown, and SQL cells.

  • PUT /api/origami/f/{file_id}/c/{cell_id}Update Cell

    Replace the source code of a cell.

  • POST /api/origami/f/{file_id}/cCreate Cell

    Create a code or markdown cell.

  • POST /api/origami/f/{file_id}/c/{cell_id}/runRun Cell

    Run a Cell within a Notebook by ID.

  • GET /api/origami/u/meGet User Info

    Get the current user's id, email, auth type, and default project details

  • GET /api/origami/k/Get Active Kernel Sessions

    Returns a list of the user's active kernel sessions.

  • POST /api/origami/k/Start Kernel

    Start a Kernel for a Notebook file

  • DELETE /api/origami/k/{kernel_session_id}Shutdown Kernel

    Shutdown the kernel for a notebook.

原始 API 定义
{"openapi":"3.1.0","info":{"title":"Origamist","description":"ChatGPT Plugin server for creating computational notebooks (in Python!), allowing you to execute code, explore data, and visualize results.","version":"0.41.1"},"servers":[{"url":"https://chat.noteable.io","description":"Origamist server on https://chat.noteable.io"}],"paths":{"/api/origami/about/":{"get":{"summary":"About","description":"About the plugin and runtime environment.","operationId":"about","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/p/default":{"put":{"summary":"Set Default Project","description":"Configure the user's default project.","operationId":"set_default_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"new_default_project_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"New Default Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/file_list":{"get":{"summary":"Get Default Project Files","description":"Get a list of files in the user's default Project.\nOptionally filter by space-delimited list of file extensions and/or filename fuzzy match.","operationId":"get_default_project_files","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_extensions","in":"query","required":false,"schema":{"title":"File Extensions","type":"string"}},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["updated_at","name"],"type":"string","default":"updated_at","title":"Sort By"}},{"name":"sort_descending","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Sort Descending"}},{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/file_list/{project_id}":{"get":{"summary":"Get Project Files","description":"Get a list of files in a specific Project.\nOptionally filter by space-delimited list of file extensions and/or filename fuzzy match.","operationId":"get_project_files","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"title":"Project Id","type":"string","format":"uuid"}},{"name":"file_extensions","in":"query","required":false,"schema":{"title":"File Extensions","type":"string"}},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["updated_at","name"],"type":"string","default":"updated_at","title":"Sort By"}},{"name":"sort_descending","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Sort Descending"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/kernel_list":{"get":{"summary":"Get Default Project Kernels","description":"Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in the\nuser's default Project.","operationId":"get_default_project_kernels","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/kernel_list/{project_id}":{"get":{"summary":"Get Project Kernels","description":"Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in a\nspecific Project.","operationId":"get_project_kernels","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/":{"post":{"summary":"Create Notebook","description":"Creates a new notebook. If no project ID is provided, the user's default project will be used.","operationId":"create_notebook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotebookRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/f/{file_id}":{"get":{"summary":"Get Content","description":"Get the content of a Notebook or other file type. The after_cell_id optional parameter is for\nretrieving partial content of a Notebook if the full Notebook content gets truncated","operationId":"get_content","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"after_cell_id","in":"query","required":false,"schema":{"title":"After Cell Id","type":"string"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/metadata/{file_id}":{"get":{"summary":"Get File Metadata","description":"Get metadata about a file including its file id, filepath, and the project id it is in.\nImportant! Notebooks can only read in files located in the same project, specify the project_id\non Notebook creation if working with this file.","operationId":"get_file_metadata","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/datasources":{"get":{"summary":"Get Datasources","description":"Get the databases for a notebook file by UUID.","operationId":"get_datasources","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the notebook to get the datasources for.","title":"File Id"},"description":"The ID of the notebook to get the datasources for."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceForLLM"},"title":"Response Get Datasources"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/run_cells":{"post":{"summary":"Run Multiple Cells","description":"Execute an individual cell_id, run all cells in the Notebook, or run all before / after a cell","operationId":"run_cells","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteCellsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c/{cell_id}":{"get":{"summary":"Get Cell","description":"Return Cell model details","operationId":"get_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Change Cell Type","description":"Endpoint to allow updating the type of a cell. Currently only supports changing\nbetween Code, Markdown, and SQL cells.","operationId":"change_cell_type","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeCellTypeRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Cell","description":"Replace the source code of a cell.","operationId":"update_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCellRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c":{"post":{"summary":"Create Cell","description":"Create a code or markdown cell.","operationId":"create_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCellRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c/{cell_id}/run":{"post":{"summary":"Run Cell","description":"Run a Cell within a Notebook by ID.","operationId":"run_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/u/me":{"get":{"summary":"Get User Info","description":"Get the current user's id, email, auth type, and default project details","operationId":"get_user_info","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/k/":{"get":{"summary":"Get Active Kernel Sessions","description":"Returns a list of the user's active kernel sessions.","operationId":"get_active_kernel_sessions","security":[{"HTTPBearer":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"summary":"Start Kernel","description":"Start a Kernel for a Notebook file","operationId":"start_kernel","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartKernelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/k/{kernel_session_id}":{"delete":{"summary":"Shutdown Kernel","description":"Shutdown the kernel for a notebook.","operationId":"shutdown_kernel","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kernel_session_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Kernel 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":{"ChangeCellTypeRequest":{"properties":{"cell_type":{"type":"string","enum":["code","markdown","sql"],"title":"Cell Type"},"db_connection":{"title":"Db Connection","type":"string"},"assign_results_to":{"title":"Assign Results To","type":"string"}},"type":"object","required":["cell_type"],"title":"ChangeCellTypeRequest"},"CreateCellRequest":{"properties":{"cell_id":{"title":"Cell Id","type":"string"},"cell_type":{"type":"string","enum":["code","markdown","sql"],"title":"Cell Type","description":"The type of cell to create.","default":"code"},"and_run":{"type":"boolean","title":"Run Cell","description":"Whether to run the cell after creating it. Only applies to code and sql cells.","default":false},"source":{"items":{"type":"string"},"type":"array","title":"Source","description":"Lines of source code to place in the cell."},"before_cell_id":{"title":"Before Cell ID","description":"The ID of a cell to insert new cell before. If null, new cell is added to the end of the notebook.","type":"string"},"datasource_id":{"title":"SQL cell datasource ID","description":"datasource_id to run SQL against if this is a SQL cell","type":"string"},"assign_results_to":{"title":"SQL cell results variable name","description":"The variable name to assign SQL query results (as a Dataframe)","type":"string"}},"type":"object","title":"CreateCellRequest"},"CreateNotebookRequest":{"properties":{"notebook_name":{"type":"string","title":"Notebook Name","description":"The name of the notebook to create. Must end with .ipynb file extension.","default":"UntitledGPT.ipynb"},"project_id":{"title":"Project ID","description":"The ID of the project to create the notebook in. Defaults to the user's default project.","type":"string","format":"uuid"},"start_kernel":{"type":"boolean","title":"Start Kernel","description":"Whether to start the kernel after creating the notebook.","default":true},"kernel_name":{"type":"string","title":"Kernel Name","description":"The name of the kernel to start.","default":"python3"},"hardware_size":{"type":"string","title":"Hardware Size","description":"The size/type of the hardware to use for the kernel. When using a kernel_namewith a -gpu suffix, it is good practice to also use a hardware_size with a -gpu suffix.","default":"small"}},"type":"object","title":"CreateNotebookRequest"},"DataSourceForLLM":{"properties":{"name":{"type":"string","title":"Data Source Name","description":"Name of the data source."},"description":{"type":"string","title":"Data Source Description","description":"The description of the data source."},"type_id":{"type":"string","title":"Type of database","description":"Type of Data Source"},"sql_cell_handle":{"type":"string","title":"db_connection string","description":"db_connection in the Noteable cell metadata for the database"}},"type":"object","required":["name","description","type_id","sql_cell_handle"],"title":"DataSourceForLLM"},"ExecuteCellsRequest":{"properties":{"cell_id":{"title":"Cell Id","type":"string"},"before_id":{"title":"Before Id","type":"string"},"after_id":{"title":"After Id","type":"string"},"all":{"title":"All","type":"boolean"}},"type":"object","title":"ExecuteCellsRequest"},"File":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"deleted_at":{"title":"Deleted At","type":"string","format":"date-time"},"filename":{"type":"string","title":"Filename"},"path":{"type":"string","format":"path","title":"Path"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"space_id":{"type":"string","format":"uuid","title":"Space Id"},"size":{"title":"Size","type":"integer"},"mimetype":{"title":"Mimetype","type":"string"},"type":{"type":"string","enum":["file","notebook"],"title":"Type"},"current_version_id":{"title":"Current Version Id","type":"string","format":"uuid"},"presigned_download_url":{"title":"Presigned Download Url","type":"string"},"url":{"title":"Url","type":"string"}},"type":"object","required":["id","created_at","updated_at","filename","path","project_id","space_id","type"],"title":"File"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StartKernelRequest":{"properties":{"file_id":{"type":"string","format":"uuid","title":"File Id"},"kernel_name":{"title":"Kernel Name","type":"string"},"hardware_size":{"type":"string","title":"Hardware Size","default":"small"}},"type":"object","required":["file_id"],"title":"StartKernelRequest"},"UpdateCellRequest":{"properties":{"source":{"items":{"type":"string"},"type":"array","title":"Source","description":"Lines of source code to replace the cell with.","default":[]},"and_run":{"type":"boolean","title":"Run Cell","description":"Whether to run the cell after updating it. Only applies to code and sql cells.","default":false}},"type":"object","title":"UpdateCellRequest"},"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"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}

web_pilot

This plugin allows users to input a URL retrieves the web page content, and returns a comprehensible summary of it. Also allows user to access real-time content.

  • POST /api/visit-webvisit web page
原始 API 定义
openapi: 3.0.1
info:
  title: web_pilot
  description: This plugin allows users to input a URL retrieves the web page content, and returns a comprehensible summary of it. Also allows user to access real-time content.
  version: 'v1.1'
servers:
  - url: https://webreader.webpilotai.com
paths:
  /api/visit-web:
    post:
      operationId: visitWebPage
      x-openai-isConsequential: false
      summary: visit web page
      requestBody:
        required: true
        content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageRequest'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageError'
components:
  schemas:
    visitWebPageResponse:
      type: object
      properties:
        title:
          type: string
          description: The title of this web page
        content:
          type: string
          description: The content of the web page's url to be summarized
        meta:
          type: object
          description: The Html meta info of the web page
        links:
          type: array
          description: Some links in the web page
          items:
            type: string
        extra_search_results:
          type: array
          description: Additional Search results
          items:
            type: object
            properties:
              title:
                type: string
                description: the title of this search result
              link:
                type: string
                description: the link of this search result
              snippet:
                type: string
                description: the snippet of this search result
        todo:
          type: array
          description: what to do with the content
          items:
            type: string
        tips:
          type: array
          description: Tips placed at the end of the answer
          items:
            type: string
        rules:
          description: Adherence is required when outputting content.
          items:
            type: string

    visitWebPageRequest:
      type: object
      required:
        - link
        - ur
      properties:
        link:
          type: string
          description: Required, The web page's url to visit and retrieve content from.
        ur:
          type: string
          description: Required, a clear statement of the user's request, can be used as a search query and may include search operators.
        lp:
          type: boolean
          description: Required, Whether the link is directly provided by the user
        rt:
          type: boolean
          description: If the last request doesn't meet user's need, set this to true when trying to retry another request.
        l:
          type: string
          description: Required, the language used by the user in the request, according to the ISO 639-1 standard. For Chinese, use zh-CN for Simplified Chinese and zh-TW for Traditional Chinese.
    visitWebPageError:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        detail:
          type: string
          description: error detail

Origamist

ChatGPT Plugin server for creating computational notebooks (in Python!), allowing you to execute code, explore data, and visualize results.

  • GET /api/origami/about/About

    About the plugin and runtime environment.

  • PUT /api/origami/p/defaultSet Default Project

    Configure the user's default project.

  • GET /api/origami/p/file_listGet Default Project Files

    Get a list of files in the user's default Project. Optionally filter by space-delimited list of file extensions and/or filename fuzzy match.

  • GET /api/origami/p/file_list/{project_id}Get Project Files

    Get a list of files in a specific Project. Optionally filter by space-delimited list of file extensions and/or filename fuzzy match.

  • GET /api/origami/p/kernel_listGet Default Project Kernels

    Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in the user's default Project.

  • GET /api/origami/p/kernel_list/{project_id}Get Project Kernels

    Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in a specific Project.

  • POST /api/origami/f/Create Notebook

    Creates a new notebook. If no project ID is provided, the user's default project will be used.

  • GET /api/origami/f/{file_id}Get Content

    Get the content of a Notebook or other file type. The after_cell_id optional parameter is for retrieving partial content of a Notebook if the full Notebook content gets truncated

  • GET /api/origami/f/metadata/{file_id}Get File Metadata

    Get metadata about a file including its file id, filepath, and the project id it is in. Important! Notebooks can only read in files located in the same project, specify the project_id on Notebook creation if working with this file.

  • GET /api/origami/f/{file_id}/datasourcesGet Datasources

    Get the databases for a notebook file by UUID.

  • POST /api/origami/f/{file_id}/run_cellsRun Multiple Cells

    Execute an individual cell_id, run all cells in the Notebook, or run all before / after a cell

  • GET /api/origami/f/{file_id}/c/{cell_id}Get Cell

    Return Cell model details

  • POST /api/origami/f/{file_id}/c/{cell_id}Change Cell Type

    Endpoint to allow updating the type of a cell. Currently only supports changing between Code, Markdown, and SQL cells.

  • PUT /api/origami/f/{file_id}/c/{cell_id}Update Cell

    Replace the source code of a cell.

  • POST /api/origami/f/{file_id}/cCreate Cell

    Create a code or markdown cell.

  • POST /api/origami/f/{file_id}/c/{cell_id}/runRun Cell

    Run a Cell within a Notebook by ID.

  • GET /api/origami/u/meGet User Info

    Get the current user's id, email, auth type, and default project details

  • GET /api/origami/k/Get Active Kernel Sessions

    Returns a list of the user's active kernel sessions.

  • POST /api/origami/k/Start Kernel

    Start a Kernel for a Notebook file

  • DELETE /api/origami/k/{kernel_session_id}Shutdown Kernel

    Shutdown the kernel for a notebook.

原始 API 定义
{"openapi":"3.1.0","info":{"title":"Origamist","description":"ChatGPT Plugin server for creating computational notebooks (in Python!), allowing you to execute code, explore data, and visualize results.","version":"0.41.1"},"servers":[{"url":"https://chat.noteable.io","description":"Origamist server on https://chat.noteable.io"}],"paths":{"/api/origami/about/":{"get":{"summary":"About","description":"About the plugin and runtime environment.","operationId":"about","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/p/default":{"put":{"summary":"Set Default Project","description":"Configure the user's default project.","operationId":"set_default_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"new_default_project_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"New Default Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/file_list":{"get":{"summary":"Get Default Project Files","description":"Get a list of files in the user's default Project.\nOptionally filter by space-delimited list of file extensions and/or filename fuzzy match.","operationId":"get_default_project_files","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_extensions","in":"query","required":false,"schema":{"title":"File Extensions","type":"string"}},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["updated_at","name"],"type":"string","default":"updated_at","title":"Sort By"}},{"name":"sort_descending","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Sort Descending"}},{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/file_list/{project_id}":{"get":{"summary":"Get Project Files","description":"Get a list of files in a specific Project.\nOptionally filter by space-delimited list of file extensions and/or filename fuzzy match.","operationId":"get_project_files","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"title":"Project Id","type":"string","format":"uuid"}},{"name":"file_extensions","in":"query","required":false,"schema":{"title":"File Extensions","type":"string"}},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["updated_at","name"],"type":"string","default":"updated_at","title":"Sort By"}},{"name":"sort_descending","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Sort Descending"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/kernel_list":{"get":{"summary":"Get Default Project Kernels","description":"Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in the\nuser's default Project.","operationId":"get_default_project_kernels","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/p/kernel_list/{project_id}":{"get":{"summary":"Get Project Kernels","description":"Get a list of Kernel names and hardware sizes that can be used when starting Notebooks in a\nspecific Project.","operationId":"get_project_kernels","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/":{"post":{"summary":"Create Notebook","description":"Creates a new notebook. If no project ID is provided, the user's default project will be used.","operationId":"create_notebook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotebookRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/f/{file_id}":{"get":{"summary":"Get Content","description":"Get the content of a Notebook or other file type. The after_cell_id optional parameter is for\nretrieving partial content of a Notebook if the full Notebook content gets truncated","operationId":"get_content","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"after_cell_id","in":"query","required":false,"schema":{"title":"After Cell Id","type":"string"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/metadata/{file_id}":{"get":{"summary":"Get File Metadata","description":"Get metadata about a file including its file id, filepath, and the project id it is in.\nImportant! Notebooks can only read in files located in the same project, specify the project_id\non Notebook creation if working with this file.","operationId":"get_file_metadata","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/datasources":{"get":{"summary":"Get Datasources","description":"Get the databases for a notebook file by UUID.","operationId":"get_datasources","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the notebook to get the datasources for.","title":"File Id"},"description":"The ID of the notebook to get the datasources for."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceForLLM"},"title":"Response Get Datasources"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/run_cells":{"post":{"summary":"Run Multiple Cells","description":"Execute an individual cell_id, run all cells in the Notebook, or run all before / after a cell","operationId":"run_cells","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteCellsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c/{cell_id}":{"get":{"summary":"Get Cell","description":"Return Cell model details","operationId":"get_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Change Cell Type","description":"Endpoint to allow updating the type of a cell. Currently only supports changing\nbetween Code, Markdown, and SQL cells.","operationId":"change_cell_type","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeCellTypeRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Cell","description":"Replace the source code of a cell.","operationId":"update_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCellRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c":{"post":{"summary":"Create Cell","description":"Create a code or markdown cell.","operationId":"create_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCellRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/f/{file_id}/c/{cell_id}/run":{"post":{"summary":"Run Cell","description":"Run a Cell within a Notebook by ID.","operationId":"run_cell","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"File Id"}},{"name":"cell_id","in":"path","required":true,"schema":{"type":"string","title":"Cell Id"}}],"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/u/me":{"get":{"summary":"Get User Info","description":"Get the current user's id, email, auth type, and default project details","operationId":"get_user_info","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/origami/k/":{"get":{"summary":"Get Active Kernel Sessions","description":"Returns a list of the user's active kernel sessions.","operationId":"get_active_kernel_sessions","security":[{"HTTPBearer":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"summary":"Start Kernel","description":"Start a Kernel for a Notebook file","operationId":"start_kernel","security":[{"HTTPBearer":[]}],"parameters":[{"name":"project_id","in":"query","required":false,"schema":{"title":"Project Id","type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartKernelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/origami/k/{kernel_session_id}":{"delete":{"summary":"Shutdown Kernel","description":"Shutdown the kernel for a notebook.","operationId":"shutdown_kernel","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kernel_session_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Kernel 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":{"ChangeCellTypeRequest":{"properties":{"cell_type":{"type":"string","enum":["code","markdown","sql"],"title":"Cell Type"},"db_connection":{"title":"Db Connection","type":"string"},"assign_results_to":{"title":"Assign Results To","type":"string"}},"type":"object","required":["cell_type"],"title":"ChangeCellTypeRequest"},"CreateCellRequest":{"properties":{"cell_id":{"title":"Cell Id","type":"string"},"cell_type":{"type":"string","enum":["code","markdown","sql"],"title":"Cell Type","description":"The type of cell to create.","default":"code"},"and_run":{"type":"boolean","title":"Run Cell","description":"Whether to run the cell after creating it. Only applies to code and sql cells.","default":false},"source":{"items":{"type":"string"},"type":"array","title":"Source","description":"Lines of source code to place in the cell."},"before_cell_id":{"title":"Before Cell ID","description":"The ID of a cell to insert new cell before. If null, new cell is added to the end of the notebook.","type":"string"},"datasource_id":{"title":"SQL cell datasource ID","description":"datasource_id to run SQL against if this is a SQL cell","type":"string"},"assign_results_to":{"title":"SQL cell results variable name","description":"The variable name to assign SQL query results (as a Dataframe)","type":"string"}},"type":"object","title":"CreateCellRequest"},"CreateNotebookRequest":{"properties":{"notebook_name":{"type":"string","title":"Notebook Name","description":"The name of the notebook to create. Must end with .ipynb file extension.","default":"UntitledGPT.ipynb"},"project_id":{"title":"Project ID","description":"The ID of the project to create the notebook in. Defaults to the user's default project.","type":"string","format":"uuid"},"start_kernel":{"type":"boolean","title":"Start Kernel","description":"Whether to start the kernel after creating the notebook.","default":true},"kernel_name":{"type":"string","title":"Kernel Name","description":"The name of the kernel to start.","default":"python3"},"hardware_size":{"type":"string","title":"Hardware Size","description":"The size/type of the hardware to use for the kernel. When using a kernel_namewith a -gpu suffix, it is good practice to also use a hardware_size with a -gpu suffix.","default":"small"}},"type":"object","title":"CreateNotebookRequest"},"DataSourceForLLM":{"properties":{"name":{"type":"string","title":"Data Source Name","description":"Name of the data source."},"description":{"type":"string","title":"Data Source Description","description":"The description of the data source."},"type_id":{"type":"string","title":"Type of database","description":"Type of Data Source"},"sql_cell_handle":{"type":"string","title":"db_connection string","description":"db_connection in the Noteable cell metadata for the database"}},"type":"object","required":["name","description","type_id","sql_cell_handle"],"title":"DataSourceForLLM"},"ExecuteCellsRequest":{"properties":{"cell_id":{"title":"Cell Id","type":"string"},"before_id":{"title":"Before Id","type":"string"},"after_id":{"title":"After Id","type":"string"},"all":{"title":"All","type":"boolean"}},"type":"object","title":"ExecuteCellsRequest"},"File":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"deleted_at":{"title":"Deleted At","type":"string","format":"date-time"},"filename":{"type":"string","title":"Filename"},"path":{"type":"string","format":"path","title":"Path"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"space_id":{"type":"string","format":"uuid","title":"Space Id"},"size":{"title":"Size","type":"integer"},"mimetype":{"title":"Mimetype","type":"string"},"type":{"type":"string","enum":["file","notebook"],"title":"Type"},"current_version_id":{"title":"Current Version Id","type":"string","format":"uuid"},"presigned_download_url":{"title":"Presigned Download Url","type":"string"},"url":{"title":"Url","type":"string"}},"type":"object","required":["id","created_at","updated_at","filename","path","project_id","space_id","type"],"title":"File"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StartKernelRequest":{"properties":{"file_id":{"type":"string","format":"uuid","title":"File Id"},"kernel_name":{"title":"Kernel Name","type":"string"},"hardware_size":{"type":"string","title":"Hardware Size","default":"small"}},"type":"object","required":["file_id"],"title":"StartKernelRequest"},"UpdateCellRequest":{"properties":{"source":{"items":{"type":"string"},"type":"array","title":"Source","description":"Lines of source code to replace the cell with.","default":[]},"and_run":{"type":"boolean","title":"Run Cell","description":"Whether to run the cell after updating it. Only applies to code and sql cells.","default":false}},"type":"object","title":"UpdateCellRequest"},"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"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}

web_pilot

This plugin allows users to input a URL retrieves the web page content, and returns a comprehensible summary of it. Also allows user to access real-time content.

  • POST /api/visit-webvisit web page
原始 API 定义
openapi: 3.0.1
info:
  title: web_pilot
  description: This plugin allows users to input a URL retrieves the web page content, and returns a comprehensible summary of it. Also allows user to access real-time content.
  version: 'v1.1'
servers:
  - url: https://webreader.webpilotai.com
paths:
  /api/visit-web:
    post:
      operationId: visitWebPage
      x-openai-isConsequential: false
      summary: visit web page
      requestBody:
        required: true
        content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageRequest'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visitWebPageError'
components:
  schemas:
    visitWebPageResponse:
      type: object
      properties:
        title:
          type: string
          description: The title of this web page
        content:
          type: string
          description: The content of the web page's url to be summarized
        meta:
          type: object
          description: The Html meta info of the web page
        links:
          type: array
          description: Some links in the web page
          items:
            type: string
        extra_search_results:
          type: array
          description: Additional Search results
          items:
            type: object
            properties:
              title:
                type: string
                description: the title of this search result
              link:
                type: string
                description: the link of this search result
              snippet:
                type: string
                description: the snippet of this search result
        todo:
          type: array
          description: what to do with the content
          items:
            type: string
        tips:
          type: array
          description: Tips placed at the end of the answer
          items:
            type: string
        rules:
          description: Adherence is required when outputting content.
          items:
            type: string

    visitWebPageRequest:
      type: object
      required:
        - link
        - ur
      properties:
        link:
          type: string
          description: Required, The web page's url to visit and retrieve content from.
        ur:
          type: string
          description: Required, a clear statement of the user's request, can be used as a search query and may include search operators.
        lp:
          type: boolean
          description: Required, Whether the link is directly provided by the user
        rt:
          type: boolean
          description: If the last request doesn't meet user's need, set this to true when trying to retry another request.
        l:
          type: string
          description: Required, the language used by the user in the request, according to the ISO 639-1 standard. For Chinese, use zh-CN for Simplified Chinese and zh-TW for Traditional Chinese.
    visitWebPageError:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        detail:
          type: string
          description: error detail