Skip to main content
API docs by Redocly

Interactor Engine REST API (1.0.0)

Download OpenAPI specification:Download

API for managing and interacting with connectors in the Interactor Server

Authentication

Get OAuth authentication URL

Generate an OAuth authentication URL for the connector

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

redirectUrl
string
Example: redirectUrl=https://example.com

URL to redirect after authentication

skipInput
boolean

Whether to skip input during OAuth flow

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Responses

Request samples 

curl --location --request GET 'https://console.interactor.com/api/v1/connector/gmail/auth-url?account=test@interactor.com' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {your_api_key}'

Response samples

Content type
application/json
{
  • "error": "string"
}

Credentials

Get connector credential

Retrieve the credential for a specific connector account. You can get a credential after successfully authenticating with the connector or by creating a new credential by REST API.

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Responses

Request samples 

curl --location --request GET 'https://console.interactor.com/api/v1/connector/gmail/credential?account=test@interactor.com' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {your_api_key}'

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauth": { },
  • "name": "string",
  • "security": {
    }
}

Create connector credential

Create a new credential for a connector account. We support OAuth2.0 security type now.

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

Request Body schema: application/json
required
OAuthCredentialInput (object) or Array of OAuthCredentialInput (objects)
One of
account_name
required
string

Name of the account

token_name
required
string

Name for the token

access_token
required
string

OAuth access token

token_type
required
string
Value: "oauth2"

OAuth token type

code
string

OAuth authorization code

refresh_token
string

OAuth refresh token

Responses

Request samples

Content type
application/json
{
  • "credential": {
    }
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}

Delete connector credential

Delete a credential for a connector account

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Action

Execute a connector action

Execute a specific action for a connector with the provided input data

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

action_name
required
string
Example: email.send

Name of the action to execute

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Request Body schema: application/json
required
object

Input data for the action

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "input": { },
  • "output": { }
}

Get action input schema

Retrieve the input schema for a specific action step

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

action_name
required
string
Example: email.send

Name of the action to execute

query Parameters
account
required
string
Example: account=test@interactor.com

Unique identifier for your service's end user account

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Request Body schema: application/json
required
step
string

The step to get variables schema for

targetField
string

Target field for the schema

accountCredentialId
string

Optional account credential ID

Responses

Request samples

Content type
application/json
{
  • "step": "string",
  • "targetField": "string",
  • "accountCredentialId": "string"
}

Response samples

Content type
application/json
[
  • { }
]

Datatype

Execute a connector datatype

Execute a specific datatype for a connector with the provided input data

path Parameters
connector_account
required
string
Example: interactor

Account name that owns the connector

connector_name
required
string
Example: gmail

Name of the connector

datatype
required
string
Example: GmailLabel

Name of the datatype to execute

Request Body schema: application/json
required
object

Input data for the datatype

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "input": { },
  • "output": { }
}

chatbox

Execute a chatbox

Execute a chatbox by API

header Parameters
x-api-key
required
string
Example: your_api_key

API key for using Interactor Engine. You can get this from the Interactor Console.

Request Body schema: application/json
required
request
string

Responses

Request samples

Content type
application/json
{
  • "request": "Go to Main page"
}

Response samples

Content type
application/json
{
  • "input": { },
  • "output": { }
}