📖Create Ingestion

Specify the ingestion type and the detailed spec for a data source. The service will automatically ingest data in the data source. This API returns a ingestion_id, that you can use to track the ingestion status.

Confluence, Google Drive and Notion are supported. You can use OAuth to grant the access to ChatBees via UI, after logging into your account.

POST /docs/create_ingestion HTTP/1.1
Api-Key: my_api_key
Content-Type: application/json
Host: my_account_id.us-west-2.aws.chatbees.ai

# example for Confluence
{
  "namespace_name": "string",
  "collection_name": "string",
  "type": "CONFLUENCE",
  "spec": {
    // http url to Confluence 
    "url":"string",
    // Specify space to ingest all pages in the space, or cql to ingest the
    // selected pages. Please specify either space or cql, not both.
    // Optional Confluence Space
    "space": "string",
    // Optional Confluence CQL
    "cql": "string",
    // Optional Atlassian API token. If Confluence is connected via OAuth,
    // service will automatically get the access token.
    "token": "string",
    // Optional Confluence username
    "username": "string"
  }
}

# example for Google Drive
{
  "namespace_name": "string",
  "collection_name": "string",
  "type": "GDRIVE",
  "spec": {
    // Optional Google Drive token. If Drive is connected via OAuth,
    // service will automatically get the access token.
    "token": "string",
    // Optional folder name
    "folder_name":"string"
  }
}

# example for Notion
{
  "namespace_name": "string",
  "collection_name": "string",
  "type": "NOTION",
  "spec": {
    // Optional Notion token. If Notion is connected via OAuth,
    // service will automatically get the access token.
    "token": "string",
    // Optional page ids
    "page_ids": ["pageid1", "pageid2", ...]
  }
}

Response:
{
  "ingestion_id": "string"
}

Last updated