Console
    Start free

    Method: projects.locations.corpora.list

    Lists all corpora in a project.

    HTTP request

    GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/corpora

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The resource name of the project from which to list corpora.

    Query parameters

    Parameters
    pageSize

    integer

    Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20.
    pageToken

    string

    A token identifying a page of results for the server to return. Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call.
    filter

    string

    The filter applied to the returned corpora list. Only the following restrictions are supported: type=<Corpus.Type> , type!=<Corpus.Type> .

    Request body

    The request body must be empty.

    Response body

    Response message for corpora.list.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "corpora" 
 : 
 [ 
 { 
 object (  Corpus 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    corpora[]

    object ( Corpus )

    The corpora in the project.
    nextPageToken

    string

    A token to retrieve next page of results. Pass to ListCorporaRequest.page_token to obtain that page.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • visionai.corpora.list

    For more information, see the IAM documentation .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: