Character

{
    "_id": "6157772e658244b1478cae3c",
    "firstName": "Richard",
    "lastName": "Hendricks",
    "background": "Richard Hendricks is a Stanford dropout and coder at tech company Hooli. Richard quits his job to pursue his compression application Pied Piper. The company initially starts out as a simple data compression platform, but when this, and a videochat that Dinesh created with the algorithm fails, Richard pivots toward creating a new, decentralized internet, called PiperNet. For the most part, Richard is shy and weak-willed, and does not have much of a temper, but when he finally reaches his limit, is prone to intimidating explosions of anger. Richard is constantly struggling with the demands of the business world, preferring instead to disappear into the coding of his application, but realizes that as CEO he must do more.",
    "owner": "615e1eb73b98f9cf4c3c42a8",
    "created": 1634147254447
}

Get Character

GET https://getember.ai/api/character?id=:id

This endpoint retrieves a character object using the provided ObjectID.

Query Parameters

Name	Type	Description
id	string	The ObjectID of the desired character.

200 Character successfully retrieved.

{
    "_id":"6157772e658244b1478cae3c",
    "firstName":"Richard",
    "lastName":"Hendricks",
    "background":"Richard Hendricks is a Stanford dropout and coder at tech company Hooli. Richard quits his job to pursue his compression application Pied Piper. The company initially starts out as a simple data compression platform, but when this, and a videochat that Dinesh created with the algorithm fails, Richard pivots toward creating a new, decentralized internet, called PiperNet. For the most part, Richard is shy and weak-willed, and does not have much of a temper, but when he finally reaches his limit, is prone to intimidating explosions of anger. Richard is constantly struggling with the demands of the business world, preferring instead to disappear into the coding of his application, but realizes that as CEO he must do more."
}

400 The request is invalid: It may be missing required arguments or be in an incorrect format.

{
    "error":"Missing id from query string."
}

404 Could not find a character matching this query.

{}

500 If this error persists please contact support with the desired request and the provided error.

{
    "error": "Internal Server Error."
}

Post Character

POST https://getember.ai/api/character

This endpoint creates a new character object with the provided properties.

Headers

Name	Type	Description
Authorization	string	A Bearer token with your provided API key.

Request Body

Name	Type	Description
firstName	string	The first name of the character to be created.
lastName	string	The last name of the character to be created.
background	string	A written background of the character to be created. This can range from a few words to a paragraph.

201 The character was successfully created and inserted into the database. The insertedId field provides the ObjectID of the new character object.

{
    "acknowledged": true,
    "insertedId": "61577fc9765bf80c0f1d9024"
}

400 The request is invalid: It may be missing required arguments or be in an incorrect format.

{
    "error": "Missing lastName from body."
}

401 The Authorization header is missing or does not contain a valid Bearer API key.

{}

500 If this error persists please contact support with the desired request and the provided error.

{
    "error": "Internal Server Error."
}

Patch Character

PATCH https://getember.ai/api/character

Update a specified character object's values.

Headers

Name	Type	Description
Authorization	string	A Bearer token with your provided API key.

Request Body

Name	Type	Description
id	string	The ObjectID of the desired character.
firstName	string	The updated first name.
lastName	string	The updated last name.
background	string	The updated background.

200 The specified character's values have been updated with the applicable values provided in the request.

{
    "acknowledged": true,
    "modifiedCount": 1,
    "upsertedId": null,
    "upsertedCount": 0,
    "matchedCount": 1
}

400 The request is invalid: It may be missing required arguments or be in an incorrect format.

{
    "error": "Missing id from body."
}

401 The Authorization header is missing or does not contain a valid Bearer API key

{}

404 Could not find a character matching the ObjectID provided.

{
    "acknowledged": true,
    "modifiedCount": 0,
    "upsertedId": null,
    "upsertedCount": 0,
    "matchedCount": 0
}

500 If this error persists please contact support with the desired request and provided error.

{
    "error": "Internal Server Error."
}

Delete Character

DELETE https://getember.ai/api/character

Delete the specified character object.

Headers

Name	Type	Description
Authorization	string	A Bearer token with your provided API key.

Request Body

Name	Type	Description
id	string	The ObjectID of the desired character.

200 The specified character object has been successfully deleted.

{
    "acknowledged": true,
    "deletedCount": 1
}

400 The request is invalid: It may be missing required arguments or be in an incorrect format.

{
    "error": "Missing id from body."
}

401 The Authorization header is missing or does not contain a valid Bearer API key.

{}

404 Could not find a character matching the ObjectID provided.

{
    "acknowledged": true,
    "deletedCount": 0
}

500 If this error persists please contact support with the desired request and provided error.

{
    "error": "Internal Server Error."
}