List integrations

GET

Get a list of platform integrations owned by your Ada account (e.g. a developer sandbox)

Query parameters

cursorstringOptional

The id that marks the start or beginning of the returned records

limitintegerOptional>=1<=100

The number of records to return

Response

Platform integrations

datalist of objectsOptional

metaobjectOptional

GET

1 import requests
2 
3 url = "https://example.ada.support/api/v2/platform-integrations/"
4 
5 querystring = {"cursor":"5f7e0e2c1e7c7e000f0f9c3a","limit":"10"}
6 
7 headers = {"Authorization": "Bearer <apiKey>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

200Retrieved

1 {
2   "data": [
3     {
4       "id": "5df263b7db5a7e6ea03fae9b",
5       "identifier_field_path": "credentials.knowledgeHubUrl",
6       "status": "development",
7       "author": "Cool Shop",
8       "call_to_action": "Connect to Cool Shop Knowledge Hub",
9       "configuration_fields": {
10         "key": "value"
11       },
12       "contact": "help@coolshop.support",
13       "created": "2020-09-20T00:00:00Z",
14       "description": "Connect to Cool Shop Knowledge Hub to sync articles with your AI Agent's knowledge base",
15       "error_codes": {
16         "key": "value"
17       },
18       "name": "Connect to Cool Shop Knowledge Hub",
19       "oauth_callback_url": "http://coolshop.com/",
20       "scopes": [
21         "articles:read",
22         "knowledge_sources:write"
23       ],
24       "tags": [
25         "knowledge"
26       ],
27       "uninstallation_url": "http://coolshop.com/uninstall",
28       "updated": "2020-09-20T00:00:00Z"
29     }
30   ],
31   "meta": {
32     "next_page_url": "http://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
33   }
34 }

Create an integration

Up Next

Built with

1	import requests
2
3	url = "https://example.ada.support/api/v2/platform-integrations/"
4
5	querystring = {"cursor":"5f7e0e2c1e7c7e000f0f9c3a","limit":"10"}
6
7	headers = {"Authorization": "Bearer <apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"data": [
3	{
4	"id": "5df263b7db5a7e6ea03fae9b",
5	"identifier_field_path": "credentials.knowledgeHubUrl",
6	"status": "development",
7	"author": "Cool Shop",
8	"call_to_action": "Connect to Cool Shop Knowledge Hub",
9	"configuration_fields": {
10	"key": "value"
11	},
12	"contact": "help@coolshop.support",
13	"created": "2020-09-20T00:00:00Z",
14	"description": "Connect to Cool Shop Knowledge Hub to sync articles with your AI Agent's knowledge base",
15	"error_codes": {
16	"key": "value"
17	},
18	"name": "Connect to Cool Shop Knowledge Hub",
19	"oauth_callback_url": "http://coolshop.com/",
20	"scopes": [
21	"articles:read",
22	"knowledge_sources:write"
23	],
24	"tags": [
25	"knowledge"
26	],
27	"uninstallation_url": "http://coolshop.com/uninstall",
28	"updated": "2020-09-20T00:00:00Z"
29	}
30	],
31	"meta": {
32	"next_page_url": "http://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
33	}
34	}