Corpora, Query, Sources
List Corpus Source Documents
Returns details for all documents contained in the source
GET
/
api
/
corpora
/
{corpus_id}
/
sources
/
{source_id}
/
documents
cURL
curl --request GET \
--url https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents', 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/{corpus_id}/sources/{source_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"corpusId": "<string>",
"sourceId": "<string>",
"documentId": "<string>",
"created": "2023-11-07T05:31:56Z",
"mimeType": "<string>",
"metadata": {
"publicUrl": "<string>",
"language": "<string>",
"title": "<string>",
"description": "<string>",
"published": "2023-11-07T05:31:56Z",
"exampleQueries": [
"<string>"
]
},
"sizeBytes": "<string>"
}
],
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"total": 123
}Authorizations
API key
Query Parameters
The pagination cursor value.
Number of results to return per page.
⌘I
cURL
curl --request GET \
--url https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents', 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/{corpus_id}/sources/{source_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"corpusId": "<string>",
"sourceId": "<string>",
"documentId": "<string>",
"created": "2023-11-07T05:31:56Z",
"mimeType": "<string>",
"metadata": {
"publicUrl": "<string>",
"language": "<string>",
"title": "<string>",
"description": "<string>",
"published": "2023-11-07T05:31:56Z",
"exampleQueries": [
"<string>"
]
},
"sizeBytes": "<string>"
}
],
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"total": 123
}