GET
/
api
/
corpora
/
{corpus_id}
/
sources
/
{source_id}
/
documents
curl --request GET \
  --url https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}/documents \
  --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>",
      "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"
      },
      "sizeBytes": "<string>"
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
corpus_id
string
required
​
source_id
string
required

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 single complete source of information included in a corpus. In the most straight-forward case, this could be an uploaded PDF or a single webpage. However, documents can also be created from other documents during processing, for example turning an HTML page into a markdown document.

​
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