Skip to main content
GET
/
api
/
corpora
/
{corpus_id}
/
sources
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/corpora/{corpus_id}/sources \
  --header 'X-API-Key: <api-key>'
{
  "results": [
    {
      "corpusId": "<string>",
      "sourceId": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "stats": {
        "lastUpdated": "2023-11-07T05:31:56Z",
        "numDocs": 123
      },
      "loadSpec": {
        "maxDocuments": 123,
        "maxDocumentBytes": 123,
        "relevantDocumentTypes": {
          "include": {
            "mimeTypes": [
              "<string>"
            ]
          },
          "exclude": {
            "mimeTypes": [
              "<string>"
            ]
          }
        },
        "startUrls": [
          "<string>"
        ],
        "maxDepth": 123
      },
      "crawl": {
        "maxDocuments": 123,
        "maxDocumentBytes": 123,
        "relevantDocumentTypes": {
          "include": {
            "mimeTypes": [
              "<string>"
            ]
          },
          "exclude": {
            "mimeTypes": [
              "<string>"
            ]
          }
        },
        "startUrls": [
          "<string>"
        ],
        "maxDepth": 123
      },
      "upload": {
        "documentIds": [
          "<string>"
        ]
      },
      "advanced": {
        "documents": [
          {
            "documentId": "<string>",
            "exampleQueries": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
corpus_id
string<uuid>
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
​
next
string<uri> | null
Example:

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

​
previous
string<uri> | null
Example:

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

​
total
integer
Example:

123