Create Source

Create a new knowledge source.

POST /api/v1/sources

Create Source

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/sources \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "source_type_id": "<string>",
  "source_id": "<string>",
  "domain": "<string>",
  "additional_info": {},
  "auto_sync_enabled": false
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/sources"

payload = {
    "name": "<string>",
    "source_type_id": "<string>",
    "source_id": "<string>",
    "domain": "<string>",
    "additional_info": {},
    "auto_sync_enabled": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    source_type_id: '<string>',
    source_id: '<string>',
    domain: '<string>',
    additional_info: {},
    auto_sync_enabled: false
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "name": "<string>",
  "object": "source",
  "source_type": "<string>",
  "source_id": "<string>",
  "domain": "<string>",
  "sync_status": "<string>",
  "auto_sync_enabled": false,
  "last_synced_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for creating a source.

name · string · required

source_type_id · string · required

source_id · string | null

domain · string | null

additional_info · Additional Info · object | null

auto_sync_enabled · boolean · default: false

Response

201 - application/json

Created

Stripe-aligned source response.

id · string · required

name · string · required

object · string · default: source

source_type · string | null

source_id · string | null

domain · string | null

sync_status · string | null

auto_sync_enabled · boolean · default: false

last_synced_at · string<date-time> | null

created_at · string<date-time> | null

updated_at · string<date-time> | null