PATCH
/
api
/
corpora
/
{corpus_id}
cURL
curl --request PATCH \
  --url https://api.ultravox.ai/api/corpora/{corpus_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "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
  }
}'
{
  "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
  }
}
Allows partial modifications to the corpus.

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
corpus_id
string<uuid>
required

Body

application/json

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

​
corpusId
string

The unique ID of this corpus.

​
created
string<date-time>

When this corpus was created.

​
name
string

The name of this corpus.

​
description
string

A description of this corpus.

​
stats
object

The current stats for this corpus. The current stats for a corpus. This gives an indication of whether the corpus is queryable and what sorts of results can be expected.

Response

200 - application/json

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

​
corpusId
string

The unique ID of this corpus.

​
created
string<date-time>

When this corpus was created.

​
name
string

The name of this corpus.

​
description
string

A description of this corpus.

​
stats
object

The current stats for this corpus. The current stats for a corpus. This gives an indication of whether the corpus is queryable and what sorts of results can be expected.