{"info":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","description":"

The Amplify AI Platform API provides a suite of RESTful API's.

\n\n

Call Basics

\n\n

All calls made to the API are POST calls.

\n\n

Each endpoint URL must be prefixed with the version of the API being called. The current version is v2.0

\n\n

The optional body of each request is JSON formatted text.

\n\n

Every API endpoint supports a callstate attribute. Any value passed in the callstate attribute is returned unaltered in the response ticket. This allows you as a developer to pass in state data that your application would like to include in responses.

\n\n

For example

\n\n

{    \n    \"chatLogs\": [ ],\n    \"callstate\":\"1234\"\n}\n\n

Returns

\n\n

{\n\"ticket\": {\n    \"authtoken\": \"\",\n    \"authtoken-expiration\": \"600\",\n    \"endpoint\": \"/chatLogs/get/\",\n    \"api-version\": \"1.1\",\n    \"elapsed\": \"0.007271\", \n    \"callstate\": \"1234\"\n},    \n\"results\": {\n    \"status\": \"ok\",\n    \"xstatus\": \"\",\n    \"data\": \"\"\n}\n}\n\n

Authentication

\n\n

To use the API's you must provide your API key in the header of your POST call, or as a parameter in the query string. Always keep your API key secret!

\n\n

All requests must be made over an encryptedHTTPSconnection.

\n\n

POST /v2.0/profile/get/ HTTPS/1.1\nHost: api.haleymarketing.com\napikey: xxxxx-xxxxxx-xxxxxx-xxxxx\nContent-Type: application/json\nAccept: application/json\nCache-Control: no-cache\n\n

Successful Response

\n\n

The API's successful response is a JSON payload. The payload consists of two hashes: a ticket detailing the request, and the results of the request.

\n\n

Example:

\n\n

{\n    \"ticket\":{\n        \"endpoint\":\"/v2.0/profile/get/\",\n        \"apikey\":\"xxxxx-xxxxxx-xxxxxx-xxxxx\",\n        \"elapsed\":\"0.1234\",\n        \"api-version\":\"1.1\",\n        \"callstate\":\"any string you'd like returned\"\n    },\n    \"results\":{\n        \"status\":\"ok\",\n        \"xstatus\":{\"en-US\":\"\"},\n        \"data\":\"[]\"\n    }\n}\n\n

For endpoints that return a paged list, there will be a paging object.

Request Properties
\n
- first - the first item to return, 0 based
  \n
- perPage - how many items to return
  \n
\n
Response Properties
\n
- next - the next item to request in the subsequent call as \"first\"
  \n
- count - the total number of items
  \n
- first - the position of the first item returned
  \n
- perPage - how many items to return
  \n
\n

\"paging\": {\n                \"next\": 0, \n                \"count\": \"9\",\n                \"first\": \"0\",\n                \"perPage\": \"10\"\n            },\n\n

Error Reporting

\n\n

Example of the API Error:

\n\n

{\n    \"ticket\":{\n        \"endpoint\":\"/v2.0/profile/get\",\n        \"apikey\":\"xxxxx-xxxxxx-xxxxxx-xxxxx\",\n        \"elapsed\":\"0.1234\",\n        \"api-version\":\"1.1\"\n    },\n    \"results\":{\n        \"status\":\"error\",\n        \"xstatus\":{\"en-US\":\"Unable to connect\"},\n        \"data\":\"\"\n    }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"388433","collectionId":"026039ee-9c43-4895-a899-421b3ffad8b6","publishedId":"2sAYHwKjpz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-11T23:54:29.000Z"},"item":[{"name":"Clients","item":[{"name":"Create Client","id":"b228edf0-d67f-40b2-ac27-600db0658ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Client\",\n \"address\": \"123 Main St\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"country\": \"USA\"\n}"},"url":"{{baseUrl}}/api/{{apiversion}}/clients","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b228edf0-d67f-40b2-ac27-600db0658ab3"},{"name":"Get Client by Field","id":"d9557492-0a39-41ae-b7ba-b2139f7b49a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/api/{{apiversion}}/clients/by_field/:field/:value","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients","by_field",":field",":value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"name","key":"field"},{"type":"any","value":"ExampleClient","key":"value"}]}},"response":[],"_postman_id":"d9557492-0a39-41ae-b7ba-b2139f7b49a5"},{"name":"Get Client by AID","id":"433bcb08-d7a5-4d0a-955b-abb4950cc388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/api/{{apiversion}}/clients/by_aid/:aid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients","by_aid",":aid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"12345","key":"aid"}]}},"response":[],"_postman_id":"433bcb08-d7a5-4d0a-955b-abb4950cc388"},{"name":"Get Client ICPs","id":"c9af965f-32bd-496b-b9d6-5438df634ce5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/api/{{apiversion}}/clients/:id/icps","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients",":id","icps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"c9af965f-32bd-496b-b9d6-5438df634ce5"},{"name":"List All Clients","id":"9ade6056-a379-402c-8f6d-87cd489b6a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/api/{{apiversion}}/clients","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ade6056-a379-402c-8f6d-87cd489b6a37"},{"name":"Search Clients","id":"8f4d3bb5-cf58-411a-af23-ba5f39c933b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/api/{{apiversion}}/clients/search?query=Example","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}},"urlObject":{"path":["api","{{apiversion}}","clients","search"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"Example"}],"variable":[]}},"response":[],"_postman_id":"8f4d3bb5-cf58-411a-af23-ba5f39c933b0"}],"id":"a9974da2-dd3d-4c9c-9adf-4d6c585b70cc","_postman_id":"a9974da2-dd3d-4c9c-9adf-4d6c585b70cc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"026039ee-9c43-4895-a899-421b3ffad8b6","id":"026039ee-9c43-4895-a899-421b3ffad8b6","name":"Amplify AI API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]}},"event":[{"listen":"prerequest","script":{"id":"300dbde0-7b9f-4ef5-96dc-9fae33f9fc8e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"22a21bd9-3d69-4244-a473-af643af2da3b","type":"text/javascript","exec":[""]}}]}