---
title: "List corpora"
method: GET
path: "/v0/corpora"
tags: ["Corpora"]
---

# List corpora

`GET /v0/corpora`

## Request

- Base URL: `https://docs.quivr.thevibecompany.co` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.quivr.thevibecompany.co/v0/corpora`
- Auth: HTTP bearer

Authorized Corpora only. Opaque page cursor bound to action/filter/scope; not a Change Cursor or a Record page cursor (either is 422 invalid_cursor).

## Query parameters

- `page_cursor` string
- `limit` integer
- `include_archived` boolean

## Response `200`

Successful response

- CorpusPage
  - `items` Corpus[], required
    - `archived` boolean: Reversible visibility fence; archived corpora retain all data.
    - `corpus_id` string, required
    - `name` string, required
    - `effective_retrieval` RetrievalConfig, required: Pin a plugin-provided profile when resolving config. Explicit fields override default fields by logical name; unmapped source data remains preserved. getCorpus returns the effective resolved fields. The only built-in profile, example.editorial, is illustrative (paired with the example extension namespace), not a product default; an uninstalled profile is 422 unsupported_profile.
      - `plugin_profile` string
      - `fields` FieldMapping[]
        - `name` string, required
        - `source_pointer` string
        - `type` 'string' | 'number' | 'boolean' | 'datetime' | 'string_array', required
        - `boost` integer: Positive integer BM25F weight, allowed only with the search role. For ratios 3/2/2/1.5/1 use 6/4/4/3/2.
        - `analyzer` 'folded' | 'french_light': Keyword analyzer for a separate copy of the field, also applied to queries. folded lowercases and folds accents and ligatures in any language; french_light also removes French stopwords and lightly stems. Omit for no copy; canonical text and vectors are unchanged.
        - `part_role` 'title' | 'body' | 'caption' | 'transcript': Collect canonical text Parts of this role instead of source_pointer. Requires the search role.
        - `part_key_prefix` string: Optional key prefix to narrow part_role, for example slugline-.
        - `value_pointer` string: For a string_array source, select this JSON Pointer from each array entry and flatten its string or string-array values.
        - `roles` string[], required
  - `next_page_cursor` string

## Other responses

- `default`: Structured error; see contract HTTP mapping.

---

[API](https://skmtc.dev/thevibecompany/apis/quivr-http-api.md) - [All operations](https://skmtc.dev/thevibecompany/apis/quivr-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thevibecompany/apis/quivr-http-api/revisions/4f4e30ba8f4e?raw)