GET
/
api
/
corpora
/
{corpus_id}
/
sources
/
{source_id}
curl --request GET \
  --url https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id} \
  --header 'X-API-Key: <api-key>'
{
  "corpusId": "<string>",
  "sourceId": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "stats": {
    "status": "SOURCE_STATUS_UNSPECIFIED",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "numDocs": 123
  },
  "loadSpec": {
    "maxDocuments": 123,
    "maxDocumentBytes": 123,
    "relevantDocumentTypes": {
      "include": {
        "mimeTypes": [
          "<string>"
        ]
      },
      "exclude": {
        "mimeTypes": [
          "<string>"
        ]
      }
    },
    "startUrls": [
      "<string>"
    ],
    "maxDepth": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
corpus_id
string
required
​
source_id
string
required

Response

200 - application/json

A source of documents for building a corpus. A source defines where documents are pulled from.

​
corpusId
string

The id of this source's corpus.

​
sourceId
string

The unique ID of this source.

​
created
string

When this source was created.

​
name
string

The name of this source.

​
description
string

A description of this source.

​
stats
object

The current stats for this source.

​
loadSpec
object

How to load documents for this source.

Create Corpus SourceUpdate Corpus Source