Skip to main content
POST
/
v1
/
sources
/
create
Create Connector Endpoint
curl --request POST \
  --url https://api.clarm.com/v1/sources/create \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "name": "<string>",
  "type": "ingestion_api",
  "config": {
    "base_url": "<string>",
    "web_connector_type": "recursive",
    "mintlify_cleanup": false,
    "scroll_before_scraping": true
  },
  "credential": {
    "credentials": {
      "slack_bot_token": "<string>"
    }
  },
  "refresh_freq": 123,
  "prune_freq": 123
}
'
{
  "connector_id": 123,
  "credential_id": 123,
  "status": "<string>",
  "message": "<string>"
}
Create a new data source connector with typed configuration and credentials for content ingestion.

Authorizations

fastapiusersauth
string
cookie
required

Body

application/json

Request to create a new connector

name
string
required

Name for the connector

type
enum<string>
required

Type of connector to create

Available options:
ingestion_api,
slack,
web,
google_drive,
gmail,
requesttracker,
github,
gitbook,
gitlab,
guru,
bookstack,
confluence,
slab,
jira,
productboard,
file,
notion,
zulip,
linear,
hubspot,
document360,
gong,
google_sites,
zendesk,
loopio,
dropbox,
sharepoint,
outlook,
OUTLOOK,
teams,
salesforce,
discourse,
axero,
clickup,
mediawiki,
wikipedia,
asana,
s3,
r2,
google_cloud_storage,
oci_storage,
xenforo,
not_applicable,
discord,
freshdesk,
fireflies,
egnyte,
airtable,
highspot,
bookface,
mock_connector
config
WebConnectorConfig · object
required

Connector configuration specific to the connector type

credential
CredentialData · object
required

Credential data for the connector

refresh_freq
integer | null

Refresh frequency in seconds (None for one-time indexing)

prune_freq
integer | null

Prune frequency in seconds (None to disable pruning)

Response

Successful Response

Response after creating a connector

connector_id
integer
required

ID of the created connector

credential_id
integer
required

ID of the created credential

status
string
required

Status of the creation

message
string
required

Success message