index.html.md

title	language_tabs	toc_footers	includes	search	code_clipboard	meta
API Reference	curl	<a href='https://github.com/slatedocs/slate'>Documentation Powered by Slate</a>	conversations liveTransfer conversationWebhooks errors	true	true	name content description Documentation for the Structurely API

Introduction

Welcome to the Structurely API!

These endpoints are used by partners to embed Structurely within your offering.

If you are intestested in working with us via our API please contact us at info@structurely.com

Authentication

All requests to the API in must include the header X-Api-Authorization with your API key. To get an API key please contact us.

Overview

You can configure Live Transfer to enable the AI to automatically bridge the gap between the Conversational AI and Voice. When the AI detects the lead needs to be on a phone call, it will POST a request to the liveTransferUrl. This enables your systems to broker a call between an Agent and the Lead.

Endpoints

All endpoints are hosted by the domain api.structurely.com. All requests must use https. Any request with the protocol http will be redirected to https with the status code 301. The path for the api will always start with /v1. Every resource endpoint will start with https://api.structurely.com/v1.

Types

Type	Description
ObjectId	A 24 byte hexadecimal string. See ObjectId.
Boolean	A JSON boolean represented by either true or false.
Integer	A plain integer. May be restricted by an interval (i.e. Intenger[0,), Integer[0,10], Integer(0,100]).
Float	A floating point number.
String	A plain string. When used as a url or query parameter, it must be url escaped.
DateTime	A date time string that can be parsed into a time zone aware date time object.
List	An array of values of either a primitive type or a schema. Usually has a type name defined (i.e. List<Agent>, List<Integer>)
Enum	A single value that can be any primative type. Always has a set of possible values defined (i.e. Enum{'hello', 'world'}, Enum{0, 1, 2})