MD GPT · Actions GPT

openapi: 3.0.3
info:
  title: SciSpace ResearchGPT
  version: 1.0.0
  description: This is SciSpace ResearchGPT Project which has end points to get factual scientific information for various use cases.
servers:
  - url: https://researchgpt.typeset.io/
paths:
  /api/v1/paper/:
    get:
      operationId: v1_paper_list
      description: API to get search results for user query. Use this function when user wants to search papers or get answer to a question.
      parameters:
      - name: search
        required: true
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - v1
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LitReviewResponse'
          description: 'List of all papers that can answer the asked question.'
  /api/v1/paper/{id}/:
    get:
      operationId: v1_paper_retrieve
      description: Use this get answers for a paper specific query
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      - in: query
        name: question
        schema:
          type: string
          minLength: 1
        required: true
      tags:
      - v1
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaperInfoResponse'
          description: ''
components:
  schemas:
    Author:
      type: object
      properties:
        display_name:
          type: string
        id:
          type: integer
        slug:
          type: string
        unique_id:
          type: string
        full_slug:
          type: string
      required:
      - display_name
      - full_slug
      - id
      - slug
      - unique_id
    Journal:
      type: object
      properties:
        display_name:
          type: string
        official_page:
          type: string
          format: uri
        issn:
          type: string
        alias:
          type: array
          items:
            type: string
        id:
          type: integer
        slug:
          type: string
        unique_id:
          type: string
        full_slug:
          type: string
      required:
      - alias
      - display_name
      - full_slug
      - id
      - issn
      - official_page
      - slug
      - unique_id
    LitReviewResponse:
      type: object
      properties:
        fssConfig:
          type: object
          additionalProperties: {}
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/Paper'
      required:
      - data
      - fssConfig
      - total
    Paper:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        is_archived:
          type: boolean
        full_slug:
          type: string
        journal:
          $ref: '#/components/schemas/Journal'
        conference_series:
          type: string
          readOnly: true
        date:
          type: string
          format: date-time
        is_oa:
          type: boolean
        publication_type:
          type: string
        doi:
          type: string
        authors:
          type: array
          items:
            $ref: '#/components/schemas/Author'
        affiliations:
          type: string
          readOnly: true
        fulltext_url:
          type: string
          format: uri
        fulltext_url_no_follow:
          type: boolean
        paper_urls:
          type: string
          readOnly: true
        metrics:
          type: string
          readOnly: true
        is_bookmarked:
          type: boolean
      required:
      - affiliations
      - authors
      - conference_series
      - date
      - doi
      - full_slug
      - fulltext_url
      - fulltext_url_no_follow
      - id
      - is_archived
      - is_bookmarked
      - is_oa
      - journal
      - metrics
      - paper_urls
      - publication_type
      - title
    PaperInfoResponse:
      type: object
      properties:
        paper_info:
          type: string
      required:
      - paper_info
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"