Skip to main content
PATCH
/
api
/
corpora
/
{corpus_id}
/
sources
/
{source_id}
cURL
curl --request PATCH \
  --url https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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>"
        ]
      }
    ]
  }
}
'
import requests

url = "https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}"

payload = {
    "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>"]
            }
        ] }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>']}]}
  })
};

fetch('https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
                                ]
                ]
        ]
    ]
  ]),
  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/{corpus_id}/sources/{source_id}"

	payload := strings.NewReader("{\n  \"corpusId\": \"<string>\",\n  \"sourceId\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"stats\": {\n    \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n    \"numDocs\": 123\n  },\n  \"loadSpec\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"crawl\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"upload\": {\n    \"documentIds\": [\n      \"<string>\"\n    ]\n  },\n  \"advanced\": {\n    \"documents\": [\n      {\n        \"documentId\": \"<string>\",\n        \"exampleQueries\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"corpusId\": \"<string>\",\n  \"sourceId\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"stats\": {\n    \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n    \"numDocs\": 123\n  },\n  \"loadSpec\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"crawl\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"upload\": {\n    \"documentIds\": [\n      \"<string>\"\n    ]\n  },\n  \"advanced\": {\n    \"documents\": [\n      {\n        \"documentId\": \"<string>\",\n        \"exampleQueries\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ultravox.ai/api/corpora/{corpus_id}/sources/{source_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"corpusId\": \"<string>\",\n  \"sourceId\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"stats\": {\n    \"lastUpdated\": \"2023-11-07T05:31:56Z\",\n    \"numDocs\": 123\n  },\n  \"loadSpec\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"crawl\": {\n    \"maxDocuments\": 123,\n    \"maxDocumentBytes\": 123,\n    \"relevantDocumentTypes\": {\n      \"include\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      },\n      \"exclude\": {\n        \"mimeTypes\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"startUrls\": [\n      \"<string>\"\n    ],\n    \"maxDepth\": 123\n  },\n  \"upload\": {\n    \"documentIds\": [\n      \"<string>\"\n    ]\n  },\n  \"advanced\": {\n    \"documents\": [\n      {\n        \"documentId\": \"<string>\",\n        \"exampleQueries\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
        ]
      }
    ]
  }
}
Allows partial updates to the source.

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
corpus_id
string<uuid>
required
​
source_id
string<uuid>
required

Body

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<date-time>

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

DEPRECATED. Prefer setting crawl instead. If either crawl or upload is set, this field will be ignored.

​
crawl
object

Allows loading documents by crawling the web.

​
upload
object

Allows loading from a uploaded document.

​
advanced
object

Allows loading from an advanced documents source. This is similar to an upload source, but requires setting example queries for each document. When a similar query is issued, the document will be returned in its entirety.

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<date-time>

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

DEPRECATED. Prefer setting crawl instead. If either crawl or upload is set, this field will be ignored.

​
crawl
object

Allows loading documents by crawling the web.

​
upload
object

Allows loading from a uploaded document.

​
advanced
object

Allows loading from an advanced documents source. This is similar to an upload source, but requires setting example queries for each document. When a similar query is issued, the document will be returned in its entirety.