> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# Add a knowledge base source

POST https://api.synthflow.ai/v2/knowledge_base/{knowledge_base_id}/sources
Content-Type: application/json

Reference: https://docs.synthflow.ai/api-reference/platform-api/knowledge-bases/attach-document-to-source

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Path parameters

- `knowledge_base_id` (string, required) — Knowledge base ID.

### Body (application/json)

This endpoint expects an object.

- `name` (string, optional) — Source name.
- `type` (enum, optional) — Source type.
  - Allowed values: `pdf`, `text`, `web`
- `url` (string, optional) — Source URL. Required when type is `pdf` (URL to a hosted PDF file) or `web` (URL to a website to scrape)
- `content` (string, optional) — The full text content for the knowledge base source. Required when type is `text`

## Response

### 200

200

- `status` (string, required)
- `response` (KnowledgeBaseKnowledgeBaseIdSourcesPostResponsesContentApplicationJsonSchemaResponse, required)

## Types

### KnowledgeBaseKnowledgeBaseIdSourcesPostResponsesContentApplicationJsonSchemaResponse

- `source_id` (string, required) — Unique identifier of the created source.

## Examples

### Add PDF Source

**Request**

```json
{
  "name": "Product Documentation",
  "type": "pdf",
  "url": "https://example.com/documents/product-guide.pdf"
}
```

**Response**

```json
{
  "status": "ok",
  "response": {
    "source_id": "1739253053024x397207388602947461"
  }
}
```

**SDK Code**

```python Add PDF Source
import requests

url = "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

payload = {
    "name": "Product Documentation",
    "type": "pdf",
    "url": "https://example.com/documents/product-guide.pdf"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```go Add PDF Source
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

	payload := strings.NewReader("{\n  \"name\": \"Product Documentation\",\n  \"type\": \"pdf\",\n  \"url\": \"https://example.com/documents/product-guide.pdf\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Add PDF Source
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Product Documentation\",\n  \"type\": \"pdf\",\n  \"url\": \"https://example.com/documents/product-guide.pdf\"\n}"

response = http.request(request)
puts response.read_body
```

```java Add PDF Source
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Product Documentation\",\n  \"type\": \"pdf\",\n  \"url\": \"https://example.com/documents/product-guide.pdf\"\n}")
  .asString();
```

```csharp Add PDF Source
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Product Documentation\",\n  \"type\": \"pdf\",\n  \"url\": \"https://example.com/documents/product-guide.pdf\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Add PDF Source
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Product Documentation",
  "type": "pdf",
  "url": "https://example.com/documents/product-guide.pdf"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Add Text Source

**Request**

```json
{
  "name": "Custom Knowledge",
  "type": "text",
  "content": "This is the full text content that will be added directly to the knowledge base."
}
```

**Response**

```json
{
  "status": "ok",
  "response": {
    "source_id": "1739253053024x397207388602947462"
  }
}
```

**SDK Code**

```python Add Text Source
import requests

url = "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

payload = {
    "name": "Custom Knowledge",
    "type": "text",
    "content": "This is the full text content that will be added directly to the knowledge base."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```go Add Text Source
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

	payload := strings.NewReader("{\n  \"name\": \"Custom Knowledge\",\n  \"type\": \"text\",\n  \"content\": \"This is the full text content that will be added directly to the knowledge base.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Add Text Source
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Custom Knowledge\",\n  \"type\": \"text\",\n  \"content\": \"This is the full text content that will be added directly to the knowledge base.\"\n}"

response = http.request(request)
puts response.read_body
```

```java Add Text Source
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Custom Knowledge\",\n  \"type\": \"text\",\n  \"content\": \"This is the full text content that will be added directly to the knowledge base.\"\n}")
  .asString();
```

```csharp Add Text Source
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Custom Knowledge\",\n  \"type\": \"text\",\n  \"content\": \"This is the full text content that will be added directly to the knowledge base.\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Add Text Source
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Custom Knowledge",
  "type": "text",
  "content": "This is the full text content that will be added directly to the knowledge base."
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Add Web Source

**Request**

```json
{
  "name": "Company FAQ",
  "type": "web",
  "url": "https://example.com/faq"
}
```

**Response**

```json
{
  "status": "ok",
  "response": {
    "source_id": "1739253053024x397207388602947463"
  }
}
```

**SDK Code**

```python Add Web Source
import requests

url = "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

payload = {
    "name": "Company FAQ",
    "type": "web",
    "url": "https://example.com/faq"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```go Add Web Source
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources"

	payload := strings.NewReader("{\n  \"name\": \"Company FAQ\",\n  \"type\": \"web\",\n  \"url\": \"https://example.com/faq\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Add Web Source
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Company FAQ\",\n  \"type\": \"web\",\n  \"url\": \"https://example.com/faq\"\n}"

response = http.request(request)
puts response.read_body
```

```java Add Web Source
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Company FAQ\",\n  \"type\": \"web\",\n  \"url\": \"https://example.com/faq\"\n}")
  .asString();
```

```csharp Add Web Source
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Company FAQ\",\n  \"type\": \"web\",\n  \"url\": \"https://example.com/faq\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Add Web Source
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Company FAQ",
  "type": "web",
  "url": "https://example.com/faq"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/knowledge_base/1739253053024x397207388602947460/sources")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```