Console (1.0)

Download OpenAPI specification:Download

Contact Golem.ai tech support: [email protected]

The console regroups the following engines:

NLU Studio
InboxCare Studio

Get Started

Create an account
Login
Create a project

Access Keys

Get access keys

path Parameters

projectId

required

string

Project ID

Responses

Response samples

200

Content type

application/json

[{"id": "5798f36a-7ddc-406e-92d9-1b2483883c16",
"name": "myConsoleAccessKey",
"createdAt": "2021-04-15T14:41:10+00:00"
}
]

Create access key

Create an access key

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

name

required

string

AccessKey's name

Responses

Request samples

Payload

Content type

application/json

{"name": "myAccessKey"
}

Response samples

201

Content type

application/json

{"id": "5798f36a-7ddc-406e-92d9-1b2483883c16",
"name": "myConsoleAccessKey",
"createdAt": "2021-04-15T14:41:10+00:00",
"secret": "b24f431a67edf5595925150610c162d0d7479303"
}

Delete access key

Delete an access key

path Parameters

ACCESS_KEY_ID required	string Access key
projectId required	string Project Id

Responses

Custom Fields

A Custom Field allow you to send extra custom infos in your Analysis, either text in the body or files in the attachments

Create Custom Field

Create a Custom Field for an Environment

path Parameters

environmentId

required

integer

Example: 1

Environment's Id

Request Body schema: application/json

label required	string Custom Field label
name required	string Custom Field technical name
required required	boolean Is Custom Field required in Analysis
type required	string Enum: "body" "attachment" Type of the Custom Field

Responses

Request samples

Payload

Content type

application/json

{"label": "otherAttachments",
"name": "Field for other attachments",
"required": true,
"type": "body"
}

Response samples

201

Content type

application/json

{"id": "3f6d03d1-065d-45c7-8baa-9216283e729d",
"label": "otherAttachment",
"name": "custom field for other attachment",
"required": true
}

Get All Custom Fields For An Environment

Get all custom fields with an environment id

path Parameters

environmentId

required

integer

Example: 1

Environment's Id

Responses

Response samples

200

Content type

application/json

[{"id": "3f6d03d1-065d-45c7-8baa-9216283e729d",
"label": "otherAttachment",
"name": "custom field for other attachment",
"required": true
}
]

Update Custom Field

Update a Custom Field

path Parameters

environmentId required	integer Example: 1 Environment's Id
customFieldId required	integer Example: 1 Custom Field's Id

Request Body schema: application/json

label	string Custom Field label
name	string Custom Field technical name
active	boolean Is Custom Field active
required	boolean Is Custom Field required in Analysis
type	string Enum: "body" "attachment" Type of the Custom Field

Responses

Request samples

Payload

Content type

application/json

{"label": "otherAttachments",
"name": "Field for other attachments",
"active": true,
"required": true,
"type": "body"
}

Response samples

200

Content type

application/json

{"id": "3f6d03d1-065d-45c7-8baa-9216283e729d",
"label": "otherAttachment",
"name": "custom field for other attachment",
"required": true
}

Delete a Custom Field

Delete a Custom Field From an Environment

path Parameters

environmentId required	integer Example: 1 Environment's Id
customFieldId required	integer Example: 1 Custom Field's Id

Responses

Environment

Environment.v2

id required	integer
name required	string

{"id": 0,
"name": "string"
}

Post Environment

This endpoint allow users to create Environments in a Project.

path Parameters

projectId

required

string

Project ID

Request Body schema:
application/json

t

name

required

string non-empty

The name of the new environment

Responses

Request samples

Payload

Content type

application/json

{"name": "client-demo"
}

Response samples

201
400

Content type

application/json

{"id": 15,
"name": "client-prod"
}

Edit Environment

Manipulate Environment

path Parameters

projectId required	string Project ID
environmentId required	string Environment ID

Request Body schema: application/json

One of

code required	integer
message	string

Responses

Request samples

Payload

Content type

application/json

{"name": "client-demo",
"code": 1
}

Response samples

200
400

Content type

application/json

{"id": 15,
"name": "client-prod"
}

Delete environment

path Parameters

projectId required	string Project ID
environmentId required	string Environment ID

Responses

Interaction

Get All Interactions

Get all Interactions of one Environment

query Parameters

environmentId required	integer Id of the Environment
contextId	integer To filter by contextId

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"context": {"id": 1,
"name": "My Context",
"langs": ["fr"
]
},
"idInteraction": "My Interaction",
"enabled": true,
"functions": [{"id": 1,
"name": "foo",
"functionName": "IsRightAfter",
"functionParameters": [{"name": "interactionRightBefore",
"interaction": "bar"
}
]
}
],
"descriptors": {"**langName**": ["foo"
]
},
"ordonned": true,
"parameters": [{"id": 1,
"multiple": true,
"optional": true,
"idParameter": "bar",
"resetConversation": true,
"position": null,
"archetype": {"id": 1,
"name": "foo"
},
"descriptors": {"**langName**": ["foo"
]
},
"descriptorsLeft": {"**langName**": ["foo"
]
},
"descriptorsRight": {"**langName**": ["foo"
]
}
}
]
}
]

Create Interaction

Create an Interaction for a Context

Request Body schema: application/json

idInteraction required	string Interaction's Name
enabled	boolean Is Interaction enable (false by default)
ordonned	boolean Are Interaction's Parameter Ordonned By Order (false by default)
contextId required	integer Context Id's

Responses

Request samples

Payload

Content type

application/json

{"idInteraction": "foo",
"enabled": true,
"ordonned": true,
"contextId": 1
}

Response samples

201

Content type

application/json

[{"id": 1,
"context": {"id": 1,
"name": "My Context",
"langs": ["fr"
]
},
"idInteraction": "My Interaction",
"enabled": true,
"functions": [{"id": 1,
"name": "foo",
"functionName": "IsRightAfter",
"functionParameters": [{"name": "interactionRightBefore",
"interaction": "bar"
}
]
}
],
"descriptors": {"**langName**": ["foo"
]
},
"ordonned": true,
"parameters": [{"id": 1,
"multiple": true,
"optional": true,
"idParameter": "bar",
"resetConversation": true,
"position": null,
"archetype": {"id": 1,
"name": "foo"
},
"descriptors": {"**langName**": ["foo"
]
},
"descriptorsLeft": {"**langName**": ["foo"
]
},
"descriptorsRight": {"**langName**": ["foo"
]
}
}
]
}
]

Delete Interaction

Delete An Interaction

path Parameters

interactionId

required

integer

Id of the Interaction

Responses

Get An Interaction

Get One Interaction With Id

path Parameters

interactionId

required

integer

Id of the Interaction

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"context": {"id": 1,
"name": "My Context",
"langs": ["fr"
]
},
"idInteraction": "My Interaction",
"enabled": true,
"functions": [{"id": 1,
"name": "foo",
"functionName": "IsRightAfter",
"functionParameters": [{"name": "interactionRightBefore",
"interaction": "bar"
}
]
}
],
"descriptors": {"**langName**": ["foo"
]
},
"ordonned": true,
"parameters": [{"id": 1,
"multiple": true,
"optional": true,
"idParameter": "bar",
"resetConversation": true,
"position": null,
"archetype": {"id": 1,
"name": "foo"
},
"descriptors": {"**langName**": ["foo"
]
},
"descriptorsLeft": {"**langName**": ["foo"
]
},
"descriptorsRight": {"**langName**": ["foo"
]
}
}
]
}
]

Update An Interaction

Update an Interaction

path Parameters

interactionId

required

integer

Id of the Interaction

Request Body schema: application/json

idInteraction	string Interaction's Name
enabled	boolean Is Interaction Enable
ordonned	boolean Are Interaction's Parameter Ordonned By Order
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"idInteraction": "bar",
"enabled": true,
"ordonned": true,
"parameters": [{"event": "string",
"payload": {"archetype": "string",
"multiple": true,
"optional": true,
"resetConversation": true,
"idParameter": "string"
},
"id": 0
}
],
"functions": [{"event": "IsAfterFoo",
"id": 1,
"payload": {"name": "string",
"functionName": "string",
"functionParameters": {"**paramName**": "foo"
}
}
}
]
}

Response samples

200

Content type

application/json

{"id": 1,
"context": {"id": 1,
"name": "My Context",
"langs": ["fr"
]
},
"idInteraction": "My Interaction",
"enabled": true,
"functions": [{"id": 1,
"name": "foo",
"functionName": "IsRightAfter",
"functionParameters": [{"name": "interactionRightBefore",
"interaction": "bar"
}
]
}
],
"descriptors": {"**langName**": ["foo"
]
},
"ordonned": true,
"parameters": [{"id": 1,
"multiple": true,
"optional": true,
"idParameter": "bar",
"resetConversation": true,
"position": null,
"archetype": {"id": 1,
"name": "foo"
},
"descriptors": {"**langName**": ["foo"
]
},
"descriptorsLeft": {"**langName**": ["foo"
]
},
"descriptorsRight": {"**langName**": ["foo"
]
}
}
]
}

Login

Login on the Console with your username and password to get a bearer token.

Request Body schema: application/json

Login to the Console to get an Bearer Token.

username required	string Your username
password required	string Your password

Responses

Request samples

Payload
cURL

Content type

application/json

{"username": "aUser",
"password": "aPassword"
}

Response samples

200
401

Content type

application/json

{"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTg1ODI4MDksImV4cCI6MTYxOTg3ODgwOSwicm9sZXMiOltdLCJ1c2VybmFtZSI6ImFubmUtc29waGllLnRhbmd1eUBnb2xlbS5haSJ9.TxJjklsd,sdl865lkJLKJjnSEbbnbnXy9456bKNKJ-KJ7gkR4hGFgd75rjhbKJHK-K5PulUnLJNjeq0J79RBPA0MwU2bhQrh0kKFTc2H_ON7MWCv8eNrEFb73J1IQJeETFe64Y2xWRqD62FQmR6IMrlKav8SXapvQIXOySaDDEirSi85r9xW7bsZua-IqnPayVWBfhE_0thKar4i-TlFXaWUAqb7SsIKp_Bscnn5eP6eL4EP-WlWlubNmeW1XibXx2Z360jTah_c5hndYRML5BAmO-Oy2X-879kljhgfyuiopkjhgfhgjyrtutiyopljkhGhjgjhGGHFHgfjhjHJKKJHKjhjkjh-3a_HwhfFeva0CHe5TPB42Y9Z2LuYijnS0hqkkhWT9WmjxxuPa8Iq4NitXAkql4rxIp2h7rqG6LDGTCUZTmCKMpkCbpDWWus440tJbUdrKKJ8Zdc72x_pl14P1PFFAsjC9U_rQJ4C7a0h-uckTHj3JDI2mUZ6QWt4q7iAvhxKvLPGxqx-pR4BTCMVCEN5KMVXoWR96PaNImR_wvu1r53Tx4J_V8KSbF12eJvMItBYFJ4S3W4bEusJc"
}

Organisation

List organisations

Responses

Response samples

200

Content type

application/json

[{"id": "1",
"name": "organisation1",
"createdAt": "1970-01-01T00:00:00+00:00"
},
{"id": "2",
"name": "organisation2",
"createdAt": "1970-01-02T00:00:00+00:00"
}
]

Get Organisation Information

Get organisation information

path Parameters

id

required

string

Organisation ID

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "project's name",
"createdAt": "2019-08-24T14:15:22Z",
"permissions": ["ROLE_ORGANISATION_ADMIN"
]
}

Rename organisation

Rename an organisation

path Parameters

id

required

string

Organisation ID

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "new organisation name"
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "project's name",
"createdAt": "2019-08-24T14:15:22Z"
}

List Organisation users

List organisation users

path Parameters

id

required

string

Organisation ID

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"email": "[email protected]",
"roles": ["ROLE_ORGANISATION_ADMIN"
],
"active": true,
"position": null,
"lastname": "golem",
"firstname": "golem",
"username": "[email protected]",
"recoveryToken": "72bd57c1158ec12872cb21bd6d307901de36d9c03",
"recoveryTokenExpirationDate": "1970-01-01T00:00:00+00:00",
"isHosted": true
}
]

Organisation User

Invite an existing user to an organisation.

path Parameters

id

required

string

Organisation ID

Request Body schema: application/json

email required	string
roles	Array of strings
position	string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"roles": ["ROLE_ORGANISATION_ADMIN"
],
"position": "Dev Ops"
}

Response samples

201

Content type

application/json

{"id": 1,
"username": "golem"
}

Get User from Organisation by id

Get a user by id from your organisation

path Parameters

userId required	integer User ID
organisationId required	integer Organisation ID

Responses

Response samples

200

Content type

application/json

{"id": 1,
"position": "Dev Ops",
"lastname": "golem",
"firstname": "golem"
}

Removing User from Organisation

Remove a user from your organisation

path Parameters

userId required	integer User ID
organisationId required	integer Organisation ID

Responses

Update User in Organisation

Modify information of a user in your organisation

path Parameters

userId required	integer User ID
organisationId required	integer Organisation ID

Request Body schema: application/json

position	string
email	string
firstname	string
lastname	string

Responses

Request samples

Payload

Content type

application/json

{"position": "string",
"email": "string",
"firstname": "string",
"lastname": "string"
}

Response samples

200

Content type

application/json

{"id": 1,
"email": "[email protected]",
"position": "Dev Ops",
"lastname": "golem",
"firstname": "golem",
"username": "golem"
}

Add Roles to User in Organisation

Add roles to an user in your organisation

path Parameters

organisationId required	integer Organisation ID
userId required	integer User ID

Request Body schema: application/json

roles

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"roles": ["ROLE_ORGANISATION_ADMIN"
]
}

Remove Roles to User in Organisation

Remove permissions to a user

path Parameters

organisationId required	integer Organisation ID
userId required	integer User ID

Request Body schema: application/json

roles

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"roles": ["ROLE_ORGANISATION_ADMIN"
]
}

Generate Password Token for User in Organisation

Generate a reset password token to a user and send him a mail with the link

path Parameters

organisationId required	integer Organisation ID
userId required	integer User Id

Request Body schema: application/json

recovery_url

required

string

Responses

Request samples

Payload

Content type

application/json

Example

Example-Local

{"recovery_url": "http://api.console.golem.ai/reset-password/c6c202523ff5e46adb55ed86b3945afc2cb7b0aa"
}

Response samples

200

Content type

application/json

{"token": "c6c202523ff5e46adb55ed86b3945afc2cb7b0aa"
}

List my Organisation Invites

Listing all organisation invites for current user

Responses

Response samples

200

Content type

application/json

{"createdAt": "1970-00-00T00:00:00+00:00",
"organisation": {"id": 1,
"name": "organisation name"
},
"token": "c6c202523ff5e46adb55ed86b3945afc2cb7b0aa"
}

Accept Invitation

Accept an invitation.

path Parameters

token

required

string

Invite token

Responses

Password

Edit your password

Request Body schema: application/json

oldPass required	string
newPass required	string <password>
newPassConfirm required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"oldPass": "myOldPassword",
"newPass": "myNewPassword*2",
"newPassConfirm": "myNewPassword*2"
}

Response samples

200

Content type

application/json

Example

Status 'ok'

{"status": "ok",
"message": "Votre mot de passe a correctement été mis à jour."
}

Check Token Password

Verify the token is valid

path Parameters

token

required

string

Reset password token

Responses

Send Reset Password Token By Email

Generate reset password token and send it by email

Request Body schema: application/json

email required	string <email> Your email to receive the link to reset your password
recovery_url required	string Url Sent in the Mail

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"recovery_url": "http://api.console.golem.ai/reset-password/**MyToken**"
}

Update Password With Token

Update your password

Request Body schema: application/json

token required	string User's Password Recovery Token
password required	string <password>
passwordConfirmation required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"token": "skldldfjdsfjsknrZdkdzl3439ds3",
"password": "myNewPassword*2",
"passwordConfirmation": "myNewPassword*2"
}

Projects

Create project

Create a project

Request Body schema: application/json

name required	string Project's name
projectKind required	string Project's type. NLU or IC
organisation	integer The organisation containing the Project

Responses

Request samples

Payload

Content type

application/json

{"name": "project name",
"projectKind": "IC"
}

Response samples

201

Content type

application/json

{"id": 3190,
"name": "myProject",
"createdAt": "1970-00-00T00:00:00+00:00",
"organisation": {"id": 1,
"name": "organisation name"
},
"projectKind": "NLU",
"lastEnv": 0,
"environments": [{"id": 7652,
"name": "dev",
"isProduction": false,
"createdAt": "1970-00-00T00:00:00+00:00",
"extractor": 3,
"langs": ["string"
]
}
]
}

Get projects

Get all projects

Request Body schema: application/json

Project list filters

name	string
sortField	string
asc	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"sortField": "string",
"asc": true
}

Response samples

200

Content type

application/json

[{"id": 3190,
"name": "myProject",
"createdAt": "1970-00-00T00:00:00+00:00",
"organisation": {"id": 1,
"name": "organisation name"
},
"projectKind": "IC",
"lastEnv": 0,
"environments": [{"id": 7652,
"name": "dev",
"isProduction": false,
"createdAt": "1970-00-00T00:00:00+00:00",
"extractor": 3,
"langs": ["string"
]
}
],
"permissions": ["ROLE_ORGANISATION_ADMIN"
]
}
]

Delete Project

Delete a project

path Parameters

projectID

required

integer

Example: 3193

Project's ID

Responses

Rename Project

Rename a project

path Parameters

projectID

required

integer

Example: 3193

Project's ID

Request Body schema: application/json

name

required

string

Project's name

Responses

Request samples

Payload

Content type

application/json

{"name": "myProject"
}

Response samples

200

Content type

application/json

{"id": 3190,
"name": "myProject",
"createdAt": "1970-00-00T00:00:00+00:00",
"organisation": {"id": 1,
"name": "organisation name"
},
"projectKind": "NLU",
"lastEnv": 0,
"environments": [{"id": 7652,
"name": "dev",
"isProduction": false,
"createdAt": "1970-00-00T00:00:00+00:00",
"extractor": 3,
"langs": ["string"
]
}
]
}

Change Project Organisation

Changes a project organisation

path Parameters

projectID

required

integer

Example: 3193

Project's ID

Request Body schema: application/json

organisationId

required

integer

Responses

Request samples

Payload

Content type

application/json

{"organisationId": 1
}

Response samples

200

Content type

application/json

{"id": 3190,
"name": "myProject",
"createdAt": "1970-00-00T00:00:00+00:00",
"organisation": {"id": 1,
"name": "organisation name"
},
"projectKind": "NLU",
"lastEnv": 0,
"environments": [{"id": 7652,
"name": "dev",
"isProduction": false,
"createdAt": "1970-00-00T00:00:00+00:00",
"extractor": 3,
"langs": ["string"
]
}
]
}

Get Last Environment

Get last environment used.

path Parameters

projectId

required

string

Project's ID

Responses

Response samples

200

Content type

application/json

{"id": 7661,
"name": "dev",
"createdAt": "1970-00-00T00:00:00+00:00",
"project": {"id": 3193,
"url": "http://api.console.golem.ai/v4/console/api/project/3193"
}
}

Update Last Project Environment

Update last environment used

path Parameters

projectId

required

string

Project's ID

Request Body schema: application/json

environment

required

integer

Environment Id

Responses

Request samples

Payload

Content type

application/json

{"environment": 123
}

Response samples

200

Content type

application/json

{"id": 7661,
"name": "dev",
"createdAt": "1970-00-00T00:00:00+00:00",
"project": {"id": 3193,
"url": "http://api.console.golem.ai/v4/console/api/project/3193"
}
}

Get Projects' Type

Get all project's type

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "NLU Studio",
"description": "The Mail Studio allow you to create your own tool to automated and get analyzed mails.",
"icon": "nlu",
"url": "http://api.console.golem.ai/v4/console/api/project-type/1"
}

Server

Get Server

to fill

path Parameters

id

required

string

to fill

Responses

Response samples

200

Content type

application/json

{"id": 11,
"name": "v3.13_beta_test",
"token": "f7cade1dae742a73a0072a76eeb118f5",
"branch": "v3.13_prod",
"replicas": 1,
"aiType": "prod",
"multi_lang": false,
"status": "started",
"contexts": [{"id": 10,
"name": "aaa",
"langs": ["fr",
"en"
],
"type": "context",
"countInteractions": 1
}
]
}

User

Get user information

Get the logged in user's information

Responses

Response samples

200

Content type

application/json

{"id": 1150,
"username": "[email protected]",
"lastname": "Tanguy",
"firstname": "Anne-Sophie",
"email": "[email protected]",
"isAdmin": false,
"canGhost": false,
"isGhost": false,
"organisations": [{"active": true,
"id": 1,
"name": "organisation name",
"roles": ["ROLE_RIGHT_PROJECT_CREATE",
"ROLE_RIGHT_PROJECT_RENAME"
],
"position": "Dev Ops"
}
],
"hostOrganisation": {"id": 1,
"name": "organisation name"
}
}

Edit your Profile

Edit your personal information

Request Body schema: application/json

email	string <email> User's email
firstname required	string User's firstname
lastname required	string User's lastname

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"firstname": "Lola",
"lastname": "Deltoir"
}

Response samples

200

Content type

application/json

Example

Status 'ok'

{"status": "ok",
"message": "Votre profil a correctement été mis à jour."
}

Create a new User

Create a new user. If organisation exist the user is automatically added to the organisation.

Request Body schema: application/json

email	string
firstname	string
lastname	string
username	string
organisationId	integer
position	string
roles	Array of strings Refer to documentation on organisation-level roles

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"firstname": "string",
"lastname": "string",
"username": "string",
"organisationId": 0,
"position": "string",
"roles": ["string"
]
}

Response samples

201

Content type

application/json

{"id": 1,
"username": "username",
"recoveryToken": "523b4e564e825918566811ff9bbd78cb149840ba",
"recoveryTokenExpirationDate": "1970-01-01T00:00:00+00:00"
}

Remove User

You cannot kick a user if he owns an access key which had activity in the last 3 days !

path Parameters

organisationId required	integer Organisation Id
userId required	integer User Id

Responses

Logs

Get logs with filter

path Parameters

organisationId

required

integer

Organisation Id

query Parameters

page	integer Table page
user	integer Filter by user
event	string Filter by event name
project	integer Filter by project
environment	integer Filter by environment

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "740326b2-c9c3-00ee-b778-0242sc170115",
"user": {"id": 1,
"username": "golem",
"email": "[email protected]",
"firstName": "golem",
"lastName": "golem"
},
"project": {"id": 1,
"name": "project's name"
},
"environment": [{"id": 1,
"name": "environment's name"
}
],
"event": "organisation_permissions_update",
"description": "Added permission \\\"ROLE_PROJECT_ADMIN\\\" to \\\"[email protected]\\\" on project \\\"My first nlu project\\\"",
"date": "1970-01-01T00:00:00+00:00",
"metadata": {"method": "added",
"role": "ROLE_PROJECT_ADMIN"
},
"accessKey": "ao19b403-febe-2s70-81e6-f61378098651"
}
],
"pagination": {"page": 1,
"totalItems": 10,
"totalPages": 4
}
}

Get logs with token

path Parameters

organisationId

required

integer

Organisation Id

query Parameters

limit	integer How much items are returned
token	string <uuid> Return items after pagination token

Responses

Response samples

200

Content type

application/json

{"next_token": "1sw78cve-d09e-01ce-8646-0242ze170005",
"data": [{"id": "740326b2-c9c3-00ee-b778-0242sc170115",
"user": {"id": 1,
"username": "golem",
"email": "[email protected]",
"firstName": "golem",
"lastName": "golem"
},
"project": {"id": 1,
"name": "project's name"
},
"environment": [{"id": 1,
"name": "environment's name"
}
],
"event": "organisation_permissions_update",
"description": "Added permission \\\"ROLE_PROJECT_ADMIN\\\" to \\\"[email protected]\\\" on project \\\"My first nlu project\\\"",
"date": "1970-01-01T00:00:00+00:00",
"metadata": {"method": "added",
"role": "ROLE_PROJECT_ADMIN"
},
"accessKey": "ao19b403-febe-2s70-81e6-f61378098651"
}
],
"limit": 1
}

Console (1.0)

Get Started

Access Keys

Get access keys

path Parameters

Responses

Response samples

Create access key

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete access key

path Parameters

Responses

Custom Fields

Create Custom Field

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get All Custom Fields For An Environment

path Parameters

Responses

Response samples

Update Custom Field

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete a Custom Field

path Parameters

Responses

Environment

Environment.v2

Post Environment

path Parameters

Request Body schema: application/jsonapplication/xmltext/plainapplication/json

Responses

Request samples

Response samples

Edit Environment

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete environment

path Parameters

Responses

Interaction

Get All Interactions

query Parameters

Responses

Response samples

Create Interaction

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Interaction

path Parameters

Responses

Get An Interaction

path Parameters

Responses

Response samples

Update An Interaction

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Login

Login

Request Body schema: application/json

Responses

Request Body schema:
application/json