Skip to main content

Admin APIs

The admin console is a good way to get started with Vectara. Once you're ready to integrate the platform more deeply into your application, the Admin APIs allow you to programatically manipulate corpora and perform many other operations within the system.

Full Definition​

Service​

The full definitions of the Create, Reset, and Delete gRPC APIs are covered below. The Create API allows corpora to be programatically created, up to the limit defined for the account. Reset deletes all data from a corpus, without deleting its definition, while Delete expunges both the data in the corpus and its definition.

The REST APIs are programatically derived from these definitions: see REST APIs for more information on endpoints or expand the specific API in the navigation sidebar to find REST examples in various programming languages. For more information on the programmatic conversion, see gRPC with REST and Open APIs.

protobuf
service AdminService {
  rpc CreateCorpus(com.vectara.admin.CreateCorpusRequest)
          returns (com.vectara.admin.CreateCorpusResponse) {
    option (google.api.http) = {
      post: "/v1/create-corpus"
      body: "*"
    };
  }

  rpc DeleteCorpus(com.vectara.admin.DeleteCorpusRequest)
          returns (com.vectara.admin.DeleteCorpusResponse) {
    option (google.api.http) = {
      post: "/v1/delete-corpus"
      body: "*"
    };
  }

  rpc ResetCorpus(com.vectara.admin.ResetCorpusRequest)
          returns (com.vectara.admin.ResetCorpusResponse) {
    option (google.api.http) = {
      post: "/v1/reset-corpus"
      body: "*"
    };
  }
}