Langame (1.0.9)

Download OpenAPI specification:Download

Machine conversations for human conversations

Welcome! You are at the right place to find out how to use Langame API.

You don't have an API key? Create an account and get one on Langame website.

Langame API is in beta and freely available under a rate limit, if you want to increase the rate limit, please contact us at [email protected].

For more information, read this.

Authentication

api_key

Security Scheme Type API Key
Header parameter name: X-Api-Key

Conversation

Augment your service conversations.

Starter

Request a conversation starter on any topic(s).

This is the entrypoint to request a conversation on any topic(s). You can then use it in your service.

Authorizations:
Request Body schema: application/json

Customisation of the conversation starter, default is "ice breaker".

topics
Array of strings

List of topics the conversation starters should be related to. The conversation starters will be about any of these topics.

limit
integer

Quantity of conversation starters to return.

translated
boolean

Whether to return translations (increase latency).

personas
Array of strings

A list of personas to be used to generate the conversation starters aligned on. Overwrites the given topics.

Responses

Request samples

Content type
application/json
Example

Ice breaker related to travelling.

{
  • "topics": [
    ],
  • "limit": 2,
  • "translated": true
}

Response samples

Content type
application/json
Example

Ice breaker related to travelling.

{
  • "topics": [
    ],
  • "limit": 2,
  • "translated": true,
  • "results": [
    ]
}

Collection starter

List collections.

Authorizations:

Responses

Response samples

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

Create a collection.

Authorizations:
Request Body schema: application/json
name
string

Name of the collection.

Responses

Request samples

Content type
application/json
{
  • "name": "brainy"
}

Response samples

Content type
application/json
{
  • "name": "brainy",
  • "id": "uTge4ZQ4ZQ4ZQ4ZQ4Zo"
}

Get a collection.

Authorizations:
path Parameters
collectionId
required
string
Examples:
  • uTge4ZQ4ZQ4ZQ4ZQ4Zo - A sample ID value

Collection ID to get.

Responses

Response samples

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

Get a collection' conversation starter(s).

Authorizations:
path Parameters
collectionId
required
string
Examples:
  • uTge4ZQ4ZQ4ZQ4ZQ4Zo - A sample ID value

Collection ID to get.

Responses

Response samples

Content type
application/json
Example

Ice breaker related to travelling.

{
  • "results": [
    ]
}

Add a conversation starter to a collection.

Authorizations:
path Parameters
collectionId
required
string
Examples:
  • uTge4ZQ4ZQ4ZQ4ZQ4Zo - A sample ID value

Collection ID to add.

starterId
required
string
Examples:
  • ffee3Gbefg3Gbefg3Gbe - A sample ID value

Starter ID to add.

Responses

Response samples

Content type
application/json
Example

Ice breaker related to travelling.

{
  • "results": [
    ]
}

Remove a conversation starter from a collection.

Authorizations:
path Parameters
collectionId
required
string
Examples:
  • uTge4ZQ4ZQ4ZQ4ZQ4Zo - A sample ID value

Collection ID to add.

starterId
required
string
Examples:
  • ffee3Gbefg3Gbefg3Gbe - A sample ID value

Starter ID to add.

Responses

Response samples

Content type
application/json
Example

Ice breaker related to travelling.

{
  • "results": [
    ]
}