API Reference

Welcome to the AstroAPI Reference documentation. This section provides detailed information about all available endpoints.

OpenAPI Specification

The complete API is documented using the OpenAPI 3.1 specification. Use the sidebar to browse available endpoints organized by category.

Base URL

https://api.astroapi.cloud

Authentication

All API requests require authentication via:

• API Key: X-Api-Key header

See the Authentication Guide for details.

Response Format

All responses follow the JSON:API specification:

{
  "data": {
    "type": "resource-type",
    "id": "resource-id",
    "attributes": { ... }
  }
}

Error Responses

Errors follow JSON:API error format:

{
  "errors": [{
    "status": "400",
    "title": "Bad Request",
    "detail": "Detailed error message"
  }]
}

Common HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request - Invalid parameters
401	Unauthorized - Missing or invalid authentication
403	Forbidden - Insufficient permissions or module access
404	Not Found
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

v25.12.4

AstroAPI

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Professional astrology API for natal charts, transits, synastry, and interpretations

Servers

https://api.astroapi.cloudProduction

---

Content

Content management and interpretation texts

Operations

POST/api/content/{id}/create-custom-copyPOST/api/content/{id}/restoreDELETE/api/content/{id}GET/api/content/{horoscopeType}/{contentType}POST/api/content/{horoscopeType}/{contentType}GET/api/content/{horoscopeType}/{contentType}/{id}DELETE/api/content/{horoscopeType}/{contentType}/{id}

---

Create Custom Copy

POST

/api/content/{id}/create-custom-copy

Create an organization-specific copy of system content for customization.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Create a custom copy of system content

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

POST

/api/content/{id}/create-custom-copy

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Restore Content

POST

/api/content/{id}/restore

Restore custom content to match the original system content.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Restore custom content to match system content

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

POST

/api/content/{id}/restore

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Delete Content by ID

DELETE

/api/content/{id}

Delete a content item by its ID.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Delete one content item

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

DELETE

/api/content/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

List Content

GET

/api/content/{horoscopeType}/{contentType}

Retrieve a paginated list of content items filtered by horoscope and content type.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

horoscopeType*

Typestring

Required

contentType*

Typestring

Required

Responses

Retrieve content items

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

GET

/api/content/{horoscopeType}/{contentType}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

horoscopeType*

contentType*

Samples

---

Create Content

POST

/api/content/{horoscopeType}/{contentType}

Create a new content item for a specific horoscope and content type.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

horoscopeType*

Typestring

Required

contentType*

Typestring

Required

Responses

Create content item

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

POST

/api/content/{horoscopeType}/{contentType}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

horoscopeType*

contentType*

Samples

---

Get Content

GET

/api/content/{horoscopeType}/{contentType}/{id}

Retrieve a single content item by its ID.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

horoscopeType*

Typestring

Required

contentType*

Typestring

Required

Responses

Retrieve one content item

Content-Type

application/vnd.api+json

{

"data": {

"type": "content",

"id": "string",

"attributes": {

"urn": "string",

"title": "string",

"body": "string",

"metadata": null,

"owner_type": "string",

"owner_id": "string",

"base_content_id": "string",

"created_at": "string",

"updated_at": "string"

},

"links": {

"self": "string"

}

}

}

GET

/api/content/{horoscopeType}/{contentType}/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

horoscopeType*

contentType*

Samples

---

Delete Content

DELETE

/api/content/{horoscopeType}/{contentType}/{id}

Delete a content item by horoscope type, content type, and ID.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

horoscopeType*

Typestring

Required

contentType*

Typestring

Required

Responses

Delete one content item

DELETE

/api/content/{horoscopeType}/{contentType}/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

horoscopeType*

contentType*

Samples

---

Calculations

Astrological calculations including natal charts, transits, synastry, and more

Operations

POST/api/calc/natalPOST/api/calc/synastryPOST/api/calc/compositePOST/api/calc/transitPOST/api/calc/compatibilityPOST/api/calc/solar-returnPOST/api/calc/lunar-returnPOST/api/calc/progressionsPOST/api/calc/moon-sunPOST/api/calc/chinese-horoscopePOST/api/calc/chinese-forecast

---

Natal Chart

POST

/api/calc/natal

Calculate a natal (birth) chart with planetary positions, house cusps, and aspects.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string",

"location": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate natal chart

Content-Type

application/vnd.api+json

{

"data": {

"dateTime": "string",

"aspects": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"points": {

"additionalProperties": {

}

},

"houses": {

"cusps": [

0

],

"ascmc": [

0

]

},

"chart": {

"url": "string"

}

}

}

POST

/api/calc/natal

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Synastry Chart

POST

/api/calc/synastry

Calculate synastry aspects between two birth charts for relationship analysis.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime1": "string",

"location1": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"dateTime2": "string",

"location2": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate synastry chart

Content-Type

application/vnd.api+json

{

"data": {

"aspects1to2": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"aspects2to1": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"charts": {

"additionalProperties": {

}

}

}

}

POST

/api/calc/synastry

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Composite Chart

POST

/api/calc/composite

Calculate a composite chart by combining midpoints of two birth charts.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime1": "string",

"location1": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"dateTime2": "string",

"location2": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate composite chart

Content-Type

application/vnd.api+json

{

"data": {

"points": {

"additionalProperties": {

}

},

"aspects": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"charts": {

"additionalProperties": {

}

}

}

}

POST

/api/calc/composite

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Transit Chart

POST

/api/calc/transit

Calculate planetary transits over a natal chart for a specified time period.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDate": "string",

"birthLocation": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"transitDateStart": "string",

"transitDateEnd": "string",

"transitLocation": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate transits chart

Content-Type

application/vnd.api+json

{

"data": {

"crossings": {

"additionalProperties": [

]

},

"aspects": [

]

}

}

POST

/api/calc/transit

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Compatibility Analysis

POST

/api/calc/compatibility

Calculate sun sign compatibility between two people with interpretation text.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime1": "string",

"location1": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"dateTime2": "string",

"location2": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"language": "en",

"includeText": true,

"includeReadableEntities": false

}

Responses

Calculate compatibility between two birth charts

Content-Type

application/vnd.api+json

{

"data": {

"sign1": "string",

"sign2": "string",

"scoreBasedOnElement": 0,

"scoreBasedOnSunAspect": 0,

"text": "string"

}

}

POST

/api/calc/compatibility

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Solar Return

POST

/api/calc/solar-return

Calculate the solar return chart for a specific year (birthday chart).

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDateTime": "string",

"birthLocation": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"returnYear": 0,

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate solar return chart

Content-Type

application/vnd.api+json

{

"data": {

"returnYear": 0,

"returnDate": "string",

"aspects": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"points": {

"additionalProperties": {

}

},

"houses": {

"cusps": [

0

],

"ascmc": [

0

]

},

"charts": {

"additionalProperties": {

}

}

}

}

POST

/api/calc/solar-return

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Lunar Return

POST

/api/calc/lunar-return

Calculate the lunar return chart when the Moon returns to its natal position.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDateTime": "string",

"birthLocation": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"returnDate": "string",

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate lunar return chart

Content-Type

application/vnd.api+json

{

"data": {

"returnDate": "string",

"aspects": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"points": {

"additionalProperties": {

}

},

"houses": {

"cusps": [

0

],

"ascmc": [

0

]

},

"charts": {

"additionalProperties": {

}

}

}

}

POST

/api/calc/lunar-return

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Secondary Progressions

POST

/api/calc/progressions

Calculate secondary progressions chart using the day-for-a-year method. Returns progressed planet positions and aspects to both progressed and natal planets.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDateTime": "string",

"birthLocation": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

},

"targetDate": "string",

"houseSystem": "placidus",

"language": "en",

"includeText": true,

"includeReadableEntities": false,

"points": [

"string"

],

"orbs": {

"additionalProperties": 0

}

}

Responses

Calculate secondary progressions chart

Content-Type

application/vnd.api+json

{

"data": {

"progressedDate": "string",

"natalDate": "string",

"targetDate": "string",

"aspects": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"aspectsToNatal": [

{

"pointA": "string",

"pointB": "string",

"aspect": "string",

"angle": 0,

"orb": 0,

"applying": true,

"text": "string"

}

],

"points": {

"additionalProperties": {

}

},

"natalPoints": {

"additionalProperties": {

}

},

"houses": {

"cusps": [

0

],

"ascmc": [

0

]

},

"charts": {

"additionalProperties": {

}

}

}

}

POST

/api/calc/progressions

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Moon & Sun Info

POST

/api/calc/moon-sun

Get Moon and Sun information for a specific place and time. Includes moon phase, illumination, distance, and sun rise/set/twilight times.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string",

"location": {

"longitude": 0,

"latitude": 0,

"timezone": "string"

}

}

Responses

Moon and Sun information

Content-Type

application/vnd.api+json

{

"data": {

"moon": {

"phaseName": "string",

"phase": 0,

"illumination": 0,

"age": 0,

"distance": 0,

"diameterDegrees": 0,

"rise": "string",

"set": "string"

},

"sun": {

"rise": "string",

"set": "string",

"transit": "string",

"distance": 0,

"diameterDegrees": 0,

"twilight": {

"civil": {

"begin": "string",

"end": "string"

},

"nautical": {

"begin": "string",

"end": "string"

},

"astronomical": {

"begin": "string",

"end": "string"

}

}

}

}

}

POST

/api/calc/moon-sun

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Chinese Zodiac Sign

POST

/api/calc/chinese-horoscope

Calculate the Chinese zodiac sign and element based on birth year.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDate": "string",

"language": "en",

"includeText": true,

"includeReadableEntities": false

}

Responses

Calculate Chinese horoscope sign

Content-Type

application/vnd.api+json

{

"data": {

"sign": "string",

"element": "string",

"year": 0,

"text": "string"

}

}

POST

/api/calc/chinese-horoscope

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Chinese Zodiac Forecast

POST

/api/calc/chinese-forecast

Get Chinese zodiac forecast for a specific year with category breakdowns.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"birthDate": "string",

"forecastYear": 0,

"language": "en",

"includeText": true,

"includeReadableEntities": false

}

Responses

Calculate Chinese horoscope forecast

Content-Type

application/vnd.api+json

{

"data": {

"sign": "string",

"year": 0,

"text": "string",

"categories": {

"additionalProperties": "string"

}

}

}

POST

/api/calc/chinese-forecast

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Organizations

Organization and team management

Operations

POST/api/orgGET/api/org/usersPOST/api/org/usersDELETE/api/org/users/{memberId}PATCH/api/org/users/{memberId}

---

Create Organization

POST

/api/org

Create a new organization with Stripe billing setup.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

Create organization

Content-Type

application/vnd.api+json

[

]

POST

/api/org

Playground

Authorization

ApiKeyAuth

Samples

---

List Members

GET

/api/org/users

Get a paginated list of organization members.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List organization users

Content-Type

application/vnd.api+json

{

"links": {

"self": "string",

"next": "string"

},

"data": [

{

"id": "string",

"type": "user",

"attributes": {

"email": "string",

"name": "string",

"role": "string"

}

}

],

"meta": {

"count": 0

}

}

GET

/api/org/users

Playground

Authorization

ApiKeyAuth

Samples

---

Add Member

POST

/api/org/users

Add or invite a new member to the organization.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"email": "string",

"name": "string",

"role": "string"

}

Responses

Member toegevoegd/uitgenodigd

Content-Type

application/vnd.api+json

{

"data": {

"memberId": "string",

"userId": "string",

"role": "string"

}

}

POST

/api/org/users

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Remove Member

DELETE

/api/org/users/{memberId}

Remove a member from the organization.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

memberId*

Typestring

Required

Min Length1

Responses

Member verwijderd

DELETE

/api/org/users/{memberId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

memberId*

Samples

---

Update Member

PATCH

/api/org/users/{memberId}

Update an organization member's role.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

memberId*

Typestring

Required

Min Length1

Request Body

application/json

{

"role": "string"

}

Responses

Member geüpdatet

Content-Type

application/vnd.api+json

{

"data": {

"memberId": "string",

"role": "string"

}

}

PATCH

/api/org/users/{memberId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

memberId*

Body

Samples

---

Modules

Module access and subscription management

Operations

GET/api/modulesGET/api/modules/organizationGET/api/modules/plansGET/api/modules/check/{moduleId}

---

List Modules

GET

/api/modules

Get all available modules with pricing information.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List all available modules

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"description": "string",

"category": "string",

"horoscopeType": "string",

"contentType": "string",

"priceCents": 0

}

]

}

GET

/api/modules

Playground

Authorization

ApiKeyAuth

Samples

---

Organization Modules

GET

/api/modules/organization

Get the list of modules the current organization has access to.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List modules for current organization

Content-Type

application/json

{

"data": [

"string"

]

}

GET

/api/modules/organization

Playground

Authorization

ApiKeyAuth

Samples

---

Subscription Plans

GET

/api/modules/plans

Get all available subscription plans with included modules and pricing.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List all subscription plans

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"description": "string",

"modules": [

"string"

],

"discountPercentage": 0,

"priceCents": 0,

"stripePriceId": "string"

}

]

}

GET

/api/modules/plans

Playground

Authorization

ApiKeyAuth

Samples

---

Check Module Access

GET

/api/modules/check/{moduleId}

Check if the current organization has access to a specific module.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

moduleId*

Typestring

Required

Responses

Check module access

Content-Type

application/json

{

"hasAccess": true

}

GET

/api/modules/check/{moduleId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

moduleId*

Samples

---

API Keys

API key management

Operations

GET/api/api-keysPOST/api/api-keysGET/api/api-keys/available-optionsGET/api/api-keys/{id}DELETE/api/api-keys/{id}PATCH/api/api-keys/{id}

---

List API Keys

GET

/api/api-keys

Get all API keys owned by the current user.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List of API keys

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"prefix": "string",

"start": "string",

"organizationId": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresAt": "string",

"createdAt": "string",

"updatedAt": "string",

"rateLimitEnabled": true,

"rateLimitTimeWindow": 0,

"rateLimitMax": 0,

"requestCount": 0,

"lastRequest": "string"

}

]

}

GET

/api/api-keys

Playground

Authorization

ApiKeyAuth

Samples

---

Create API Key

POST

/api/api-keys

Create a new API key with optional permission and module restrictions.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"name": "string",

"organizationId": "string",

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresIn": 0

}

Responses

API key created

Content-Type

application/json

{

"data": {

"id": "string",

"key": "string",

"name": "string",

"prefix": "string",

"organizationId": "string",

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresAt": "string"

}

}

POST

/api/api-keys

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Available Options

GET

/api/api-keys/available-options

Get available permissions and modules for configuring API keys.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

Available options

Content-Type

application/json

{

"permissions": [

{

"id": "string",

"description": "string"

}

],

"modules": [

{

"id": "string",

"name": "string"

}

],

"userRole": "string",

"rolePermissions": [

"string"

]

}

GET

/api/api-keys/available-options

Playground

Authorization

ApiKeyAuth

Samples

---

Get API Key

GET

/api/api-keys/{id}

Get details of a specific API key.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

API key details

Content-Type

application/json

{

"data": {

"id": "string",

"name": "string",

"prefix": "string",

"start": "string",

"organizationId": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresAt": "string",

"createdAt": "string",

"updatedAt": "string",

"rateLimitEnabled": true,

"rateLimitTimeWindow": 0,

"rateLimitMax": 0,

"requestCount": 0,

"lastRequest": "string"

}

}

GET

/api/api-keys/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Delete API Key

DELETE

/api/api-keys/{id}

Permanently delete an API key.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

API key deleted

DELETE

/api/api-keys/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Update API Key

PATCH

/api/api-keys/{id}

Update an API key's name, status, permissions, or modules.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"name": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

]

}

Responses

API key updated

Content-Type

application/json

{

"data": {

"id": "string",

"name": "string",

"prefix": "string",

"start": "string",

"organizationId": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresAt": "string",

"createdAt": "string",

"updatedAt": "string",

"rateLimitEnabled": true,

"rateLimitTimeWindow": 0,

"rateLimitMax": 0,

"requestCount": 0,

"lastRequest": "string"

}

}

PATCH

/api/api-keys/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Body

Samples

---

Horoscope

Operations

GET/api/horoscope/daily/{date}GET/api/horoscope/weekly/{year}/{week}/{zodiacSign}GET/api/horoscope/yearly/{year}/{zodiacSign}GET/api/horoscope/yearly-ascendant/{year}/{zodiacSign}

---

Get Daily Horoscopes

GET

/api/horoscope/daily/{date}

Retrieve daily horoscopes for all zodiac signs for a specific date.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

date*

Typestring

Required

Pattern"^\\d{4}-\\d{2}-\\d{2}$"

Responses

Daily horoscopes for all zodiac signs

Content-Type

application/vnd.api+json

{

"data": {

"type": "daily-horoscope",

"attributes": {

"date": "string",

"language": "string",

"horoscopes": {

"additionalProperties": {

}

}

}

}

}

GET

/api/horoscope/daily/{date}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

date*

Samples

---

Get Weekly Horoscope Report

GET

/api/horoscope/weekly/{year}/{week}/{zodiacSign}

Retrieve weekly horoscope report for a specific zodiac sign and week.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

year*

Typestring

Required

Pattern"^\\d{4}$"

week*

Typestring

Required

Pattern"^(0[1-9]|[1-4]\\d|5[0-3])$"

zodiacSign*

Typestring

Required

Responses

Weekly horoscope report

Content-Type

application/vnd.api+json

{

"data": {

"type": "string",

"attributes": {

"reportType": "string",

"zodiacSign": "string",

"period": {

"year": "string",

"week": "string"

},

"language": "string",

"title": "string",

"body": "string",

"metadata": null

}

}

}

GET

/api/horoscope/weekly/{year}/{week}/{zodiacSign}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

year*

week*

zodiacSign*

Samples

---

Get Yearly Horoscope Report

GET

/api/horoscope/yearly/{year}/{zodiacSign}

Retrieve yearly horoscope report for a specific zodiac sign and year.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

year*

Typestring

Required

Pattern"^\\d{4}$"

zodiacSign*

Typestring

Required

Responses

Yearly horoscope report

Content-Type

application/vnd.api+json

{

"data": {

"type": "string",

"attributes": {

"reportType": "string",

"zodiacSign": "string",

"period": {

"year": "string",

"week": "string"

},

"language": "string",

"title": "string",

"body": "string",

"metadata": null

}

}

}

GET

/api/horoscope/yearly/{year}/{zodiacSign}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

year*

zodiacSign*

Samples

---

Get Yearly Ascendant Horoscope Report

GET

/api/horoscope/yearly-ascendant/{year}/{zodiacSign}

Retrieve yearly horoscope report for a specific ascendant sign and year.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

year*

Typestring

Required

Pattern"^\\d{4}$"

zodiacSign*

Typestring

Required

Responses

Yearly ascendant horoscope report

Content-Type

application/vnd.api+json

{

"data": {

"type": "string",

"attributes": {

"reportType": "string",

"zodiacSign": "string",

"period": {

"year": "string",

"week": "string"

},

"language": "string",

"title": "string",

"body": "string",

"metadata": null

}

}

}

GET

/api/horoscope/yearly-ascendant/{year}/{zodiacSign}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

year*

zodiacSign*

Samples

---

Numerology

Operations

POST/api/numerology/profilePOST/api/numerology/life-pathPOST/api/numerology/expressionPOST/api/numerology/soul-urgePOST/api/numerology/personalityPOST/api/numerology/birthdayPOST/api/numerology/personal-cyclesPOST/api/numerology/compatibility

---

Full Numerology Profile

POST

/api/numerology/profile

Calculate a complete numerology profile including Life Path, Expression, Soul Urge, Personality, Birthday numbers, Personal Cycles, and identify Master/Karmic numbers.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string",

"fullName": "string"

}

Responses

Complete numerology profile

Content-Type

application/vnd.api+json

{

"data": {

"lifePathNumber": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"expressionNumber": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"soulUrgeNumber": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalityNumber": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"birthdayNumber": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalYear": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalMonth": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalDay": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"karmicDebtNumbers": [

0

],

"masterNumbers": [

0

]

}

}

POST

/api/numerology/profile

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Life Path Number

POST

/api/numerology/life-path

Calculate the Life Path Number from birth date. This is the most important number in numerology, representing your life's purpose.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string"

}

Responses

Life Path number calculation

Content-Type

application/vnd.api+json

{

"data": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

POST

/api/numerology/life-path

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Expression Number

POST

/api/numerology/expression

Calculate the Expression (Destiny) Number from full name. This number reveals your natural talents and abilities.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"fullName": "string"

}

Responses

Expression number calculation

Content-Type

application/vnd.api+json

{

"data": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

POST

/api/numerology/expression

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Soul Urge Number

POST

/api/numerology/soul-urge

Calculate the Soul Urge (Heart's Desire) Number from vowels in the name. This number reveals your inner motivations.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"fullName": "string"

}

Responses

Soul Urge number calculation

Content-Type

application/vnd.api+json

{

"data": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

POST

/api/numerology/soul-urge

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Personality Number

POST

/api/numerology/personality

Calculate the Personality Number from consonants in the name. This number reveals how others perceive you.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"fullName": "string"

}

Responses

Personality number calculation

Content-Type

application/vnd.api+json

{

"data": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

POST

/api/numerology/personality

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Birthday Number

POST

/api/numerology/birthday

Calculate the Birthday Number from the day of birth. This number represents a special talent you possess.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string"

}

Responses

Birthday number calculation

Content-Type

application/vnd.api+json

{

"data": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

POST

/api/numerology/birthday

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Personal Cycles

POST

/api/numerology/personal-cycles

Calculate Personal Year, Month, and Day numbers. These reveal the current energetic influences in your life.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime": "string",

"currentDate": "string"

}

Responses

Personal cycles calculation

Content-Type

application/vnd.api+json

{

"data": {

"personalYear": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalMonth": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"personalDay": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

}

}

}

POST

/api/numerology/personal-cycles

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Numerology Compatibility

POST

/api/numerology/compatibility

Calculate compatibility between two people based on their Life Path numbers.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"dateTime1": "string",

"dateTime2": "string"

}

Responses

Compatibility calculation

Content-Type

application/vnd.api+json

{

"data": {

"person1LifePath": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"person2LifePath": {

"value": 0,

"isMasterNumber": true,

"isKarmicDebt": true,

"reducedFrom": 0,

"calculation": "string"

},

"compatibilityScore": 0,

"relationship": "string",

"description": "string"

}

}

POST

/api/numerology/compatibility

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Chatbot

Operations

GET/api/chatbotsPOST/api/chatbotsGET/api/chatbots/{id}DELETE/api/chatbots/{id}PATCH/api/chatbots/{id}GET/api/chatbots/{id}/profilesPOST/api/chatbots/{id}/profilesDELETE/api/chatbots/{id}/profiles/{profileId}GET/api/chatbots/pluginsGET/api/chatbots/usage

---

List Chatbots

GET

/api/chatbots

List all chatbots for the current organization

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List of chatbots

Content-Type

application/vnd.api+json

[

]

GET

/api/chatbots

Playground

Authorization

ApiKeyAuth

Samples

---

Create Chatbot

POST

/api/chatbots

Create a new chatbot for the organization

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body

application/json

{

"data": {

"type": "chatbots",

"attributes": {

"name": "string",

"description": "string",

"enabledPlugins": [

"string"

],

"settings": {

"additionalProperties": "string"

},

"widgetConfig": {

"additionalProperties": "string"

},

"allowedDomains": [

"string"

]

}

}

}

Responses

Created chatbot

Content-Type

application/vnd.api+json

[

]

POST

/api/chatbots

Playground

Authorization

ApiKeyAuth

Body

Samples

---

Get Chatbot

GET

/api/chatbots/{id}

Get a specific chatbot by ID

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Chatbot details

Content-Type

application/vnd.api+json

[

]

GET

/api/chatbots/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Delete Chatbot

DELETE

/api/chatbots/{id}

Delete a chatbot

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Chatbot deleted

DELETE

/api/chatbots/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Update Chatbot

PATCH

/api/chatbots/{id}

Update an existing chatbot

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"data": {

"type": "chatbots",

"id": "string",

"attributes": {

"name": "string",

"description": "string",

"enabledPlugins": [

"string"

],

"settings": {

"additionalProperties": "string"

},

"widgetConfig": {

"additionalProperties": "string"

},

"allowedDomains": [

"string"

]

}

}

}

Responses

Updated chatbot

Content-Type

application/vnd.api+json

[

]

PATCH

/api/chatbots/{id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Body

Samples

---

List Chat Profiles

GET

/api/chatbots/{id}/profiles

List all chat profiles for a chatbot

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Responses

List of profiles

Content-Type

application/vnd.api+json

[

]

GET

/api/chatbots/{id}/profiles

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Samples

---

Create Chat Profile

POST

/api/chatbots/{id}/profiles

Create a pre-configured chat profile with birth data

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"data": {

"type": "chat-profile",

"attributes": {

"externalUserId": "string",

"birthDate": "string",

"birthTime": "string",

"birthPlaceLat": 0,

"birthPlaceLng": 0,

"birthPlaceName": "string",

"timezone": "string",

"metadata": {

"additionalProperties": "string"

}

}

}

}

Responses

Created profile

Content-Type

application/vnd.api+json

[

]

POST

/api/chatbots/{id}/profiles

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

Body

Samples

---

Delete Chat Profile

DELETE

/api/chatbots/{id}/profiles/{profileId}

Delete a chat profile

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

id*

Typestring

Required

profileId*

Typestring

Required

Responses

Profile deleted

DELETE

/api/chatbots/{id}/profiles/{profileId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

id*

profileId*

Samples

---

List Available Plugins

GET

/api/chatbots/plugins

List all available chatbot plugins

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

List of plugins

Content-Type

application/vnd.api+json

[

]

GET

/api/chatbots/plugins

Playground

Authorization

ApiKeyAuth

Samples

---

Get Chatbot Usage

GET

/api/chatbots/usage

Get chatbot usage statistics for the current organization

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses

Usage statistics

Content-Type

application/vnd.api+json

[

]

GET

/api/chatbots/usage

Playground

Authorization

ApiKeyAuth

Samples

---

Chat

Operations

POST/api/chat/{chatbotId}POST/api/chat/{chatbotId}/profile/{profileId}POST/api/chat/{chatbotId}/directGET/api/chat/{chatbotId}/conversation/{conversationId}DELETE/api/chat/{chatbotId}/conversation/{conversationId}

---

Chat with Chatbot

POST

/api/chat/{chatbotId}

Send a message to a chatbot and receive a streaming response via SSE

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

Request Body

application/json

{

"message": "string",

"conversationId": "string"

}

Responses

SSE stream with chat response

Content-Type

text/event-stream

[

]

POST

/api/chat/{chatbotId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

Body

Samples

---

Chat with Profile

POST

/api/chat/{chatbotId}/profile/{profileId}

Send a message using a pre-configured user profile

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

profileId*

Typestring

Required

Request Body

application/json

{

"message": "string",

"conversationId": "string"

}

Responses

SSE stream with chat response

Content-Type

text/event-stream

[

]

POST

/api/chat/{chatbotId}/profile/{profileId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

profileId*

Body

Samples

---

Chat with Birth Data

POST

/api/chat/{chatbotId}/direct

Send a message with inline birth data (no profile needed)

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

Request Body

application/json

{

"message": "string",

"conversationId": "string",

"birthData": {

"date": "string",

"time": "string",

"latitude": 0,

"longitude": 0,

"placeName": "string",

"timezone": "string"

}

}

Responses

SSE stream with chat response

Content-Type

text/event-stream

[

]

POST

/api/chat/{chatbotId}/direct

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

Body

Samples

---

Get Conversation

GET

/api/chat/{chatbotId}/conversation/{conversationId}

Retrieve conversation history

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

conversationId*

Typestring

Required

Responses

Conversation data

GET

/api/chat/{chatbotId}/conversation/{conversationId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

conversationId*

Samples

---

Delete Conversation

DELETE

/api/chat/{chatbotId}/conversation/{conversationId}

Delete a conversation and its history

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

conversationId*

Typestring

Required

Responses

Conversation deleted

DELETE

/api/chat/{chatbotId}/conversation/{conversationId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

conversationId*

Samples

---

Widget

Operations

GET/widget/config/{chatbotId}POST/widget/chat/{chatbotId}POST/widget/chat/{chatbotId}/user/{externalUserId}

---

Get Widget Configuration

GET

/widget/config/{chatbotId}

Get the widget configuration for embedding

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

Responses

Widget configuration

GET

/widget/config/{chatbotId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

Samples

---

Widget Chat

POST

/widget/chat/{chatbotId}

Send a message via widget (SSE streaming response)

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

Request Body

application/json

{

"message": "string",

"conversationId": "string",

"birthData": {

"date": "string",

"time": "string",

"latitude": 0,

"longitude": 0,

"placeName": "string",

"timezone": "string"

}

}

Responses

SSE stream with chat response

Content-Type

text/event-stream

[

]

POST

/widget/chat/{chatbotId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

Body

Samples

---

Widget Chat with User Profile

POST

/widget/chat/{chatbotId}/user/{externalUserId}

Chat using an external user ID (creates profile on first use)

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters

Path Parameters

chatbotId*

Typestring

Required

externalUserId*

Typestring

Required

Request Body

application/json

{

"message": "string",

"conversationId": "string",

"birthData": {

"date": "string",

"time": "string",

"latitude": 0,

"longitude": 0,

"placeName": "string",

"timezone": "string"

}

}

Responses

SSE stream with chat response

Content-Type

text/event-stream

[

]

POST

/widget/chat/{chatbotId}/user/{externalUserId}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

chatbotId*

externalUserId*

Body

Samples

---

Powered by VitePress OpenAPI