Create a Document
curl --request POST \
--url https://app.baseplate.ai/api/datasets/{id}/documents \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"content": "<string>",
"parse_url": true,
"chunk_size": 123,
"chunk_overlap": 123,
"metadata": {}
}
'import requests
url = "https://app.baseplate.ai/api/datasets/{id}/documents"
payload = {
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"content": "<string>",
"parse_url": True,
"chunk_size": 123,
"chunk_overlap": 123,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
filename: '<string>',
url: '<string>',
content: '<string>',
parse_url: true,
chunk_size: 123,
chunk_overlap: 123,
metadata: {}
})
};
fetch('https://app.baseplate.ai/api/datasets/{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://app.baseplate.ai/api/datasets/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'filename' => '<string>',
'url' => '<string>',
'content' => '<string>',
'parse_url' => true,
'chunk_size' => 123,
'chunk_overlap' => 123,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.baseplate.ai/api/datasets/{id}/documents"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://app.baseplate.ai/api/datasets/{id}/documents")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.baseplate.ai/api/datasets/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyDocuments
Create a Document
POST
/
api
/
datasets
/
{id}
/
documents
Create a Document
curl --request POST \
--url https://app.baseplate.ai/api/datasets/{id}/documents \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"content": "<string>",
"parse_url": true,
"chunk_size": 123,
"chunk_overlap": 123,
"metadata": {}
}
'import requests
url = "https://app.baseplate.ai/api/datasets/{id}/documents"
payload = {
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"content": "<string>",
"parse_url": True,
"chunk_size": 123,
"chunk_overlap": 123,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
filename: '<string>',
url: '<string>',
content: '<string>',
parse_url: true,
chunk_size: 123,
chunk_overlap: 123,
metadata: {}
})
};
fetch('https://app.baseplate.ai/api/datasets/{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://app.baseplate.ai/api/datasets/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'filename' => '<string>',
'url' => '<string>',
'content' => '<string>',
'parse_url' => true,
'chunk_size' => 123,
'chunk_overlap' => 123,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.baseplate.ai/api/datasets/{id}/documents"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://app.baseplate.ai/api/datasets/{id}/documents")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.baseplate.ai/api/datasets/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"filename\": \"<string>\",\n \"url\": \"<string>\",\n \"content\": \"<string>\",\n \"parse_url\": true,\n \"chunk_size\": 123,\n \"chunk_overlap\": 123,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
Dataset ID
Header
Baseplate API key. Must be in the format βBearer $BASEPLATE_API_KEYβ
Body
The document ID to create. Must be unique within a dataset.
The name of the file
The url of the file
Content of a document to add.
If true, will GET the url and parse the response as a document.
Sets the chunk size if parse_url or content is set.
Sets the chunk overlap if parse_url or content is set.
Metadata to add to every row in the document. Optional.
βI