Skip to main content
POST
/
api
/
corpora
cURL
curl --request POST \
  --url https://api.ultravox.ai/api/corpora \
  --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": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "numChunks": 123,
    "numDocs": 123,
    "numVectors": 123
  }
}
'
import requests

url = "https://api.ultravox.ai/api/corpora"

payload = {
"corpusId": "<string>",
"created": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"stats": {
"lastUpdated": "2023-11-07T05:31:56Z",
"numChunks": 123,
"numDocs": 123,
"numVectors": 123
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
corpusId: '<string>',
created: '2023-11-07T05:31:56Z',
name: '<string>',
description: '<string>',
stats: {
lastUpdated: '2023-11-07T05:31:56Z',
numChunks: 123,
numDocs: 123,
numVectors: 123
}
})
};

fetch('https://api.ultravox.ai/api/corpora', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ultravox.ai/api/corpora",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'corpusId' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'description' => '<string>',
'stats' => [
'lastUpdated' => '2023-11-07T05:31:56Z',
'numChunks' => 123,
'numDocs' => 123,
'numVectors' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.ultravox.ai/api/corpora"

payload := strings.NewReader("{\n \"corpusId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stats\": {\n \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n \"numChunks\": 123,\n \"numDocs\": 123,\n \"numVectors\": 123\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.ultravox.ai/api/corpora")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"corpusId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stats\": {\n \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n \"numChunks\": 123,\n \"numDocs\": 123,\n \"numVectors\": 123\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ultravox.ai/api/corpora")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"corpusId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"stats\": {\n \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n \"numChunks\": 123,\n \"numDocs\": 123,\n \"numVectors\": 123\n }\n}"

response = http.request(request)
puts response.read_body
{
  "corpusId": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "stats": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "numChunks": 123,
    "numDocs": 123,
    "numVectors": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key

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.

Response

201 - 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.