Lawyer AI - India · GPT-Aktionen

{
  "openapi": "3.0.0",
  "info": {
    "title": "Indian Kanoon API",
    "description": "API for accessing Indian Kanoon legal document services.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.indiankanoon.org",
      "description": "Indian Kanoon API Server"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "Token"
      }
    },
    "schemas": {
      "SearchResult": {
        "type": "object",
        "properties": {
          "docs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Document"
            }
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "Document": {
        "type": "object",
        "properties": {
          "tid": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      },
      "DocumentFragment": {
        "type": "object",
        "properties": {
          "fragment": {
            "type": "string"
          }
        }
      },
      "DocumentMeta": {
        "type": "object",
        "properties": {
          "meta": {
            "type": "string"
          },
          "citeList": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "citedbyList": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/search/": {
      "get": {
        "operationId": "searchDocuments",
        "summary": "Search for documents based on query input.",
        "parameters": [
          {
            "name": "formInput",
            "in": "query",
            "required": true,
            "description": "Query for the search API.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pagenum",
            "in": "query",
            "description": "Page number, starts at 0.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful search operation.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResult"
                }
              }
            }
          }
        }
      }
    },
    "/doc/{docid}/": {
      "get": {
        "operationId": "getDocumentById",
        "summary": "Get a specific document by ID.",
        "parameters": [
          {
            "name": "docid",
            "in": "path",
            "required": true,
            "description": "The ID of the document to retrieve.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A specific document retrieved successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          }
        }
      }
    },
    "/docfragment/{docid}/": {
      "get": {
        "operationId": "getDocumentFragment",
        "summary": "Get document fragments by ID.",
        "parameters": [
          {
            "name": "docid",
            "in": "path",
            "required": true,
            "description": "The ID of the document to retrieve fragments for.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "formInput",
            "in": "query",
            "description": "Query for the document fragments.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Document fragments retrieved successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentFragment"
                }
              }
            }
          }
        }
      }
    },
    "/docmeta/{docid}/": {
      "get": {
        "operationId": "getDocumentMeta",
        "summary": "Get document metadata by ID.",
        "parameters": [
          {
            "name": "docid",
            "in": "path",
            "required": true,
            "description": "The ID of the document to retrieve metadata for.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Document metadata retrieved successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentMeta"
                }
              }
            }
          }
        }
      }
    }
  }
}