Ingest pages from a Confluence space
curl --request POST \
--url https://api.example.com/v1/knowledge/ingest/confluence \
--header 'Content-Type: application/json' \
--data '
{
"connector_id": "<string>",
"space_key": "<string>",
"teams": [],
"tags": []
}
'import requests
url = "https://api.example.com/v1/knowledge/ingest/confluence"
payload = {
"connector_id": "<string>",
"space_key": "<string>",
"teams": [],
"tags": []
}
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({connector_id: '<string>', space_key: '<string>', teams: [], tags: []})
};
fetch('https://api.example.com/v1/knowledge/ingest/confluence', 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.example.com/v1/knowledge/ingest/confluence",
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([
'connector_id' => '<string>',
'space_key' => '<string>',
'teams' => [
],
'tags' => [
]
]),
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://api.example.com/v1/knowledge/ingest/confluence"
payload := strings.NewReader("{\n \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\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://api.example.com/v1/knowledge/ingest/confluence")
.header("Content-Type", "application/json")
.body("{\n \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge/ingest/confluence")
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 \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body{
"space_key": "<string>",
"space_name": "<string>",
"source": "<string>",
"documents": [
{
"page_id": "<string>",
"title": "<string>",
"doc_id": "<string>",
"chunks": 0,
"skipped": false,
"skip_reason": "<string>"
}
],
"total_pages": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}ingest
Ingest pages from a Confluence space
Given a connector_id and space_key, fetch all pages from the Confluence space, create placeholder documents, and index them in the background.
POST
/
v1
/
knowledge
/
ingest
/
confluence
Ingest pages from a Confluence space
curl --request POST \
--url https://api.example.com/v1/knowledge/ingest/confluence \
--header 'Content-Type: application/json' \
--data '
{
"connector_id": "<string>",
"space_key": "<string>",
"teams": [],
"tags": []
}
'import requests
url = "https://api.example.com/v1/knowledge/ingest/confluence"
payload = {
"connector_id": "<string>",
"space_key": "<string>",
"teams": [],
"tags": []
}
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({connector_id: '<string>', space_key: '<string>', teams: [], tags: []})
};
fetch('https://api.example.com/v1/knowledge/ingest/confluence', 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.example.com/v1/knowledge/ingest/confluence",
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([
'connector_id' => '<string>',
'space_key' => '<string>',
'teams' => [
],
'tags' => [
]
]),
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://api.example.com/v1/knowledge/ingest/confluence"
payload := strings.NewReader("{\n \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\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://api.example.com/v1/knowledge/ingest/confluence")
.header("Content-Type", "application/json")
.body("{\n \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge/ingest/confluence")
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 \"connector_id\": \"<string>\",\n \"space_key\": \"<string>\",\n \"teams\": [],\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body{
"space_key": "<string>",
"space_name": "<string>",
"source": "<string>",
"documents": [
{
"page_id": "<string>",
"title": "<string>",
"doc_id": "<string>",
"chunks": 0,
"skipped": false,
"skip_reason": "<string>"
}
],
"total_pages": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json