GET
/
api
/
corpora
curl --request GET \
  --url https://api.ultravox.ai/api/corpora \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "corpusId": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "stats": {
        "status": "CORPUS_STATUS_UNSPECIFIED",
        "lastUpdated": "2023-11-07T05:31:56Z",
        "numChunks": 123,
        "numDocs": 123,
        "numVectors": 123
      }
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Query Parameters

​
cursor
string

The pagination cursor value.

​
pageSize
integer

Number of results to return per page.

Response

200 - application/json
​
results
object[]
required

A queryable collection of documents. A corpus can be used to ground Ultravox with factual content for a particular domain.

​
next
string | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

​
previous
string | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

​
total
integer
Example:

123