Stella Platform Documentation

Stella Platform Documentation

  • Docs
  • Procedures
  • Reference
  • FAQ
  • Bot API
  • API
  • Languages iconEnglish
    • 中文

›Reference

Get Started

  • Introduction

Reference

  • Message Event
  • Node
  • Member
  • Channel
  • Integrations
  • Agenda Meta
  • Group
  • Methods
  • Radiate.js
  • Access Control List
  • Stella Open API

Stella Open API

Introduction

Stella API is built around GraphQL. It is recommended to have prior knowledge of GraphQL in order to make use of the Stella API.

You can visit our Open API Playground, where you can test our Open API. For your reference, API Documentation and Schema are also available at the right side of the playground.

Open API Playground

Endpoint URL

Please use the following Endpoint URL for Stella API: https://openapi.stellabot.com/v2

Authentication

  1. Follow this guide to generate an access token from your Stella app.

  2. In the Open API playground, insert the access token into the HTTP HEADERS.

{
"Authorization": "Bearer [access_token]"
}

Open API Playground

How to test our API calls?

  1. Write your query on the left panel. You can try with the following call to get conversation history.
query getChatHistory ($first: IntMax100) {
  apiViewer {
    conversationHistory (first: $first) {
      edges {
        node {
          messageEvent
        }
      }
    }
  }
}
  1. You can refer to the SCHEMA and DOCS for other query types.

API Docs

API Schema
  1. Varaiables can be entered in the QUERY VARIABLES.

Query Variables
  1. Click the button to test the API call, the response will be displayed on the right panel.

API call sent

Rate Limit

There are rate limits on our API calls. After sending an API call to Stella with GraphQL Client (e.g. Postman), you can view the rate limit in Response Headers:

X-RateLimit-Remaining: The count of API calls that you can send in a minute

X-RateLimit-Limit: The count of API calls sent in a minute

Retry-After: The time needed until the next call after reaching the rate limit (in seconds)

Response Headers

Changelog

(Last Updated: 16/8/2021)

New API

10 New API have been added under apiViewer. Please use https://openapi.stellabot.com/master as the endpoint URL.

New api under apiViewer
actions
audiences
conditions
localeGroups
nodes
priorityGroups
responses
subscriptionPushes
trees
triggers

New Mutations

53 New Mutations have been added. Please use https://openapi.stellabot.com/master as the endpoint URL.

New Mutations
createDataSourceDocimportTreesupdateConditiondeleteAudienceupdatePriorityGroupimportMembers
updateDataSourceDocduplicateTreedeleteConditioncreateChanneldeletePriorityGroupcreateNode
deleteDataSourceDocscreateResponsecreateActionupdateChannelPriorityGroupupdateSubscriptionPushupdateNode
importDataSourceupdateResponseupdateActionupdateChanneldeleteSubscriptionPushdeleteNode
createDataSourcedeleteResponseupdateActiondeleteChannelupdateAgendaupdateAppIntegration
updateDataSourcedeleteResponsedeleteActioncreateMemberdeleteAgenda
deleteDataSourcecreateTriggerupdatePairsInAppupdateMemberexportChats
createTreeupdateTriggeraddOutletInPairdeleteMembercreateLocaleGroup
updateTreedeleteTriggercreateRetryAudienceupdateMembersupdateLocaleGroup
deleteTreecreateConditionupdateAudiencecreatePriorityGroupdeleteLocaleGroup
← Access Control List
  • Introduction
  • Endpoint URL
  • Authentication
  • How to test our API calls?
  • Rate Limit
  • Changelog
    • New API
    • New Mutations
Stella Platform Documentation
Docs
Get StartedBot API ReferenceAPI ReferenceStandard Procedures
Community
FAQUser ShowcaseChat with Us
Copyright © 2023 Sanuker Inc. Limited