Create a knowledge source

import requests
url = "https://example.ada.support/api/v2/knowledge/sources/"
payload = {
    "id": "5df263b7db5a7e6ea03fae9b",
    "name": "Ada Knowledge Base"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "5df263b7db5a7e6ea03fae9b",
  "name": "Ada Knowledge Base",
  "availability_rules": {
    "match": "all",
    "conditions": [
      {
        "variable": {
          "id": "5df263b7db5a7e6ea03fae9b"
        },
        "operator": "equals",
        "value": "en"
      }
    ]
  },
  "external_id": "external_id_1",
  "metadata": {
    "example_key1": "example_string_value",
    "example_key2": true,
    "example_key3": 123
  },
  "created": "2020-09-20T00:00:00+00:00",
  "updated": "2020-09-20T00:00:00+00:00",
  "last_sync": "2020-09-20T00:00:00+00:00",
  "status": "deleting"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

idstringRequired1-160 characters

A unique identifier for the knowledge source

namestringRequired>=1 character

The name of the knowledge source

metadataobject or nullOptional

A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.

availability_rulesobject or nullOptional

An availability-rule template for the source. Each new article created under the source whose request omits availability_rules gets it. Set it here so the first import is covered. Omit or send null for no template. A source that an App creates then gets the rules set on its connection. See Availability rules for the schema and examples.

Response

Knowledge source created

idstring

A unique identifier for the knowledge source

namestring>=1 character

The name of the knowledge source

availability_rulesobject or null

The source’s availability-rule template. Each new article created under the source whose request omits availability_rules gets it. null when the source has none.

external_idstring or nullOptional

An external identifier for the knowledge source

metadataobject or nullOptional

A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.

createdstringOptionalformat: "date-time"

The date the knowledge source was created

updatedstringOptionalformat: "date-time"

The date the knowledge source was last updated

last_syncstringOptionalformat: "date-time"

The date the knowledge source was last synchronized

statusenumOptional

Deletion lifecycle status of the knowledge source: deleting while an asynchronous deletion is in progress, delete_failed if the deletion failed. null when no deletion is in progress.

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error