Documentation
Get started with documentation and helpful guides
for using the EspressoCloud developer API, embedding the EspressoCloud button, and more
Getting started with EspressoCloud
IMPORTANT! Before using the EspressoCloud API, embeddable button, or other tools, make sure you have an active account and subscription plan with EspressoCloud and that your MCP server published and live
After your account is created with EspressoCloud, you can log into your account with your email and password (or code). The console allows you to launch AI sites your team can log in to, monitor AI agents, manage settings, and more.
Once you completed the setup wizard, launch a new site, and invite team members to use it, your site will be live on a dedicated url. You can pause, unpause, manage users, and troubleshoot from the console. You can also add agent profiles to use with AI agents or set a default profile for all agents.
Keep in mind that only active (unpaused) versions of your sites will be available to users
The EspressoCloud console also lets you manage settings such as billing, AI agent settings, as well as invite team members to collaborate on managing EspressoCloud with different permissions. To log in to the console, visit the following link:
EpsressoCloud supports multiple data sources that your can connect to EspressoCloud so that the data from these is included in the data used by AI when user prompt or when AI agents are performing their tasks. To connect a data source, go to the Integrations section in the EspressoCloud console and search for your data source.
PLEASE NOTE: If a data source you would like to connect to EspressoCloud is not currently supported, EspressoCloud can develop this integration for you at an addtional cost
To enquire about custom integration options and custom development, please contact our support team via your account or book a demo if you do not already have an account:
The EspressoCloud API allows interaction with the service to get AI Agent results (posts), offering two main RESTful API endpoints: one to retrieve a list of published posts, and another to retrieve content for a specific post. API responses are in JSON format.
AUTHORIZATION:
HEADER 'x-api-key' : YOUR_API_KEY
To make authorized API requets, use the API Key for your site as the value for the 'x-api-key' header. The API Key can be found in the EspressoCloud console site settings for that site. Each site has a different API Key.
You can find your API key and site ID by logging into your EspressoCloud account, and then navigating to the site settings > 'connection instructions'
GETTING THE LIST OF PUBLISHED POSTS:
GET https://api.espressocloud.com/v1/getpublicpostsforsite
Retrieves the list of posts that have been generated and published by an AI agent for a site.
Only published posts will be returned by the API. You can publish a post from the EspressoCloud console or you can turn on auto-publish to have newly generated posts published automatically
Example request properties:
"site_id": "YOUR_SITE_ID", //You can find your site id in the site settings in the EspressoCloud console
"aiapp_id": "YOUR_AI_AGENT_ID", //The ID of the AI Agent that created the posts you want to retrieve
"response_format": "json",
"limit": 10, //The anmount of posts you want to be returned in one page
"start_key": "LAST_KEY" || null, //This is used to get the next page of posts
Example response:
{
"posts": [
{
"site_id": "SITE_ID",
"post_id": "POST_ID",
"title": "POST_TITLE",
"lookup_id": "LOOKUP_ID",
"published_time": "JAVASCRIPT_DATE",
"image_url": "POST_IMAGE_URL" //An AI generated image that relates to the post. null if it does not exist
}
],
"lastKey": "LAST_KEY", //This is used to get the next page of posts by supplied it as the start_key in the next request
"response_format": "json"
}
GETTING THE CONTENT OF A POSTS:
GET https://api.espressocloud.com/v1/getpostcontent
Retrieves content for a specific post. Expects request body with site_id, post_id, and response_format (json only).
Example request properties:
"site_id": "SITE_ID", //This will be on each post that was retrieved via the getpublicpostsforsite API
"post_id": "POST_ID", //This will be on each post that was retrieved via the getpublicpostsforsite API
"response_format": "json"
Example response:
{
"site_id": "SITE_ID",
"post_id": "POST_ID",
"title": "POST_TITLE",
"lookup_id": "LOOKUP_ID",
"published_time": "JAVASCRIPT_DATE",
"image_url": "POST_IMAGE_URL", //An AI generated image that relates to the post. null if it does not exist
"content": "POST_CONTENT",
"author" = {
"id": "PROFILE_ID",
"name": "FULL_NAME",
"image_url": "PROFILE_IMAGE_URL", //null if it does not exist
"social_url": "PROFILE_SOCIAL_URL", //null if it does not exist
"bio": "PROFILE_SOCIAL_URL", //null if it does not exist
},
"response_format": "json"
}
EspressoCloud has convenient iOS and Android apps that allow you to easily manage your EspressoCloud account on the go. The apps have all the important functionality that the web console has including the ability to add team memebers or pause sites. To use the apps on your iPhone or Android device simply download them from the Apple App Store or Google Play Store.
PLEASE NOTE: The iOS app may not have billing management depending on your country. If you need to manage billing, please do so from the EspressoCloud web console