logo
Index
API Reference
api keys
get api keys
post an api key
auth
Sign out
Retrieve current user's QR code
capitol events
Fetch capitol events
Update a capitol event
Delete a capitol event
Create a new capitol event
Perform a bulk update operation
Re order the capitol events
Turn a event of a image into a test.
Retrieve Capitol events for a specific document
Delete a specific Capitol event
Execute a bulk update of events within a document draft
Transform an event block into a different block type
capitol projects
Delete a document from project
Retrieve a Capitol project by user
Update a Capitol project
Delete a Capitol project
Create a new Capitol project
List all Capitol projects for a user
List all Capitol documents within a project
Retrieve Capitol documents within a specific project
Move a document between projects
Remove a document from a project
Retrieve sources within a project
Copy a source to another project
Delete a source from a project
current-org
Retrieve current org
current-user
Retrieve current user
Retrieve current user
Authenticate current user with auth code
default
Retrieve user default story configurations
embeddings
Generate embeddings for json
feed
Fetch a list of stories. Based on the search params and in the filters.
feedback
Submit user feedback and receive credits
Verify if the story has been rated by its author
Record thumbs up/down feedback for a story
google-drive
Submit Google Drive authorization code for the current user
Retrieve Google Drive accounts authorized by the user
Remove Google Drive authorizations for the user
Export a story to Google Drive
guardrails
Get all guardrail config by org
Update a specific guardrail config
Create a new guardrail config
Check prompt against the guardrails checks.
Get a specific guardrail config
Delete a specific guardrail config
integration
Fake search
Fake upload sources
llm-chat
Request prompt suggestions for Block level chat
Retrieve chat history for a story or component
Submit a user message and receive an agent’s response
Reset chat history for a specific block
Request prompt suggestions for a content block
Stop the ongoing story generation
llm-socket
Request chat_id and socket_address
Initiate document generation and obtain streaming address
memberships
Stripe Webhook for Membership Updates
Retrieve Current User Membership
Retrieve All User Memberships
Get Available Membership Plans
Handle Successful Plan Purchase
Create a New Stripe Session
organizations
Fetch the details of the current organization
Update the details of an organization
Create a new organization
Fetch all organizations
Upload a logo
Fetch all api keys for the organization
Update the name of an api key
Delete an api key by id
Create a new api key for the organization
Fetch all models for the organization
Upsert the primary and seconday model for an organization
Fetch all models available for the organization
Fetch all members of the organization
Remove a member from the organization
Add a member to the organization
Fetch all members of the organization
Invite a member to the organization
Validate an invite code
prompts
Get homepage prompts
sources
It creates a WS adress for processing user's pdfs and urls.
Process the user sources.
Retrieve sources by story id
Create a WebSocket address for PDF and URL processing
Upload and process user sources asynchronously
Process JSON or URL user sources
Process files user's sources synchronously
Retrieve sources by story ID
Validate YouTube link
stories
Fetch a particular story
Update a story in the DB
Delete a story from the DB
Commit a new story to the DB
Fetch mini info of a particular story
Fetch a particular story
Patch the story visibility.
Fork a story
Retrieve a specific story
Update an existing story
Delete a story
Save a new story
Fetch story events
Fork an existing story
Retry a failing story/block
Fetch minimal story information
Toggle story visibility
story-edit
Duplicate a block in a story.
story-remix
Remix a complete story.
Remix a complete story
storyplan-config
Retrieve all story configurations for the user
Update an existing story configuration
Delete a user story configuration
Create a new story configuration
Fetch available story plan schemas
Generate title and description with AI
Retrieve user's default story configurations
Set a default story configuration for the user
Create or update a story configuration by name
tako
Retrieve Tako chart preview link
Retrieve Tako chart preview link (v2)
user
Update user data in the database.
Search users
Get user by ID
Delete user by ID
Check username availability
Upload a profile photo
Save user settings
Utility
Report the latest API version.
home
GET: /info
Report the latest API version
Search for stories and users that match a specific value. Stories are searched on headline + lead-in. Sort-by, limit, and descending are all optional (default: limit 30, most recent first).
Retrieve generated prompts for the homepage
Get all API example prompts
Create a new API example prompt
Delete an API example prompt by ID
regenerate prompts
Get all API prompts
Create a new API prompt
Delete an API prompt by ID
Initiate Twitter OAuth authentication
Handle Twitter OAuth callback
Post a tweet with media
Retrieve all visible notifications for a user
Soft delete a notification
Create a new notification
Apply credits to a user's account with a promo code
Directly add credits to a user's account
powered by zuplo
Sign in

Capitol AI Services API

The Capitol AI Services API acts as the interface between users and Capitol's AI-powered services, such as story generation.

                      **Features:**
                      - **User Management:** Create, update, and manage user accounts.
                      - **Session Handling:** Secure authentication and session management.
                      - **AI Content Generation:** Generate dynamic content like stories using AI.
BASE URL
https://api.capitol.ai

prompts

ENDPOINTS
GET/prompts

capitol projects

ENDPOINTS
DELETE/project/docs
GET/api/:api-version-string/project
PUT/api/:api-version-string/project
DELETE/api/:api-version-string/project
POST/api/:api-version-string/project
GET/api/:api-version-string/project/list
GET/api/:api-version-string/project/docs/list
GET/api/:api-version-string/project/docs
PUT/api/:api-version-string/project/docs
DELETE/api/:api-version-string/project/docs
GET/api/:api-version-string/project/source
PUT/api/:api-version-string/project/source
DELETE/api/:api-version-string/project/source

capitol events

ENDPOINTS
GET/events
PATCH/events
DELETE/events
POST/events
PATCH/events/bulk
POST/events/reorder
POST/events/turn-into
GET/api/:api-version-string/events
DELETE/api/:api-version-string/events
PATCH/api/:api-version-string/events/bulk
POST/api/:api-version-string/events/turn-into

current-user

ENDPOINTS
GET/user/current-user
GET/api/:api-version-string/user/current-user
POST/api/:api-version-string/user/current-user

sources

ENDPOINTS
POST/user/sources/ws
POST/user/sources/upload-source
GET/user/sources/story
POST/api/:api-version-string/user/sources/ws
POST/api/:api-version-string/user/sources/upload-source
POST/api/:api-version-string/user/sources/upload-source/sync
POST/api/:api-version-string/user/sources/upload-source/file
GET/api/:api-version-string/user/sources/story
POST/api/:api-version-string/user/sources/youtube

default

ENDPOINTS
GET/user/storyplan-config/default

stories

ENDPOINTS
GET/stories/story
PUT/stories/story
DELETE/stories/story
POST/stories/story
GET/stories/mini
GET/stories/story/events
PATCH/stories/visibility
POST/stories/fork
GET/api/:api-version-string/stories/story
PUT/api/:api-version-string/stories/story
DELETE/api/:api-version-string/stories/story
POST/api/:api-version-string/stories/story
GET/api/:api-version-string/stories/story/events
POST/api/:api-version-string/stories/story/fork
POST/api/:api-version-string/stories/story/retry
GET/api/:api-version-string/stories/mini
PATCH/api/:api-version-string/stories/visibility

story-edit

ENDPOINTS
POST/stories/fork-block

story-remix

ENDPOINTS
POST/stories/remix/story
POST/api/:api-version-string/stories/remix/story

feed

ENDPOINTS
GET/stories/feed

llm-socket

ENDPOINTS
POST/chat/async
POST/api/:api-version-string/chat/async

llm-chat

ENDPOINTS
POST/chat/block-suggestions
GET/api/:api-version-string/chat
POST/api/:api-version-string/chat
POST/api/:api-version-string/chat/reset-block-chat
POST/api/:api-version-string/chat/block-suggestions
POST/api/:api-version-string/chat/cancel

Utility

ENDPOINTS
GET/api/:api-version-string/api-version

integration

ENDPOINTS
GET/api/:api-version-string/integration/sources
POST/api/:api-version-string/integration/upload

tako

ENDPOINTS
GET/api/:api-version-string/tako
GET/api/:api-version-string/tako/v2

google-drive

ENDPOINTS
POST/api/:api-version-string/drive/auth
GET/api/:api-version-string/drive/user
DELETE/api/:api-version-string/drive/user
POST/api/:api-version-string/drive/export

api keys

ENDPOINTS
GET/api/:api-version-string/api-keys
POST/api/:api-version-string/api-keys

organizations

ENDPOINTS
GET/api/:api-version-string/org
PATCH/api/:api-version-string/org
POST/api/:api-version-string/org
GET/api/:api-version-string/org/all
POST/api/:api-version-string/org/logo
GET/api/:api-version-string/org/key
PATCH/api/:api-version-string/org/key
DELETE/api/:api-version-string/org/key
POST/api/:api-version-string/org/key
GET/api/:api-version-string/org/models
POST/api/:api-version-string/org/models
GET/api/:api-version-string/org/models/list
GET/api/:api-version-string/org/member
DELETE/api/:api-version-string/org/member
POST/api/:api-version-string/org/member
GET/api/:api-version-string/org/member/list
POST/api/:api-version-string/org/member/invite
POST/api/:api-version-string/org/member/invite/validate

guardrails

ENDPOINTS
GET/api/:api-version-string/configs/guardrails
PATCH/api/:api-version-string/configs/guardrails
POST/api/:api-version-string/configs/guardrails
POST/api/:api-version-string/configs/guardrails/check/prompt
GET/api/:api-version-string/configs/guardrails/:id
DELETE/api/:api-version-string/configs/guardrails/:id

embeddings

ENDPOINTS
POST/api/:api-version-string/embeddings/vector

user

ENDPOINTS
PUT/api/:api-version-string/user
GET/api/:api-version-string/user/users
GET/api/:api-version-string/user/users/:id
DELETE/api/:api-version-string/user/users/:id
GET/api/:api-version-string/user/username
POST/api/:api-version-string/user/avatar
POST/api/:api-version-string/user/settings

auth

ENDPOINTS
GET/api/:api-version-string/user/sign-out
GET/api/:api-version-string/user/qr-code

current-org

ENDPOINTS
GET/api/:api-version-string/user/current-org

memberships

ENDPOINTS
POST/api/:api-version-string/user/membership/stripe-webhook
GET/api/:api-version-string/user/membership/current-membership
GET/api/:api-version-string/user/membership/all
GET/api/:api-version-string/user/membership/products
GET/api/:api-version-string/user/membership/success
GET/api/:api-version-string/user/membership/session

feedback

ENDPOINTS
POST/api/:api-version-string/user/feedback
GET/api/:api-version-string/user/feedback/thumbs
POST/api/:api-version-string/user/feedback/thumbs

storyplan-config

ENDPOINTS
GET/api/:api-version-string/user/storyplan-config
PUT/api/:api-version-string/user/storyplan-config
DELETE/api/:api-version-string/user/storyplan-config
POST/api/:api-version-string/user/storyplan-config
GET/api/:api-version-string/user/storyplan-config/schemas
POST/api/:api-version-string/user/storyplan-config/gen-mode-data
GET/api/:api-version-string/user/storyplan-config/default
POST/api/:api-version-string/user/storyplan-config/default
POST/api/:api-version-string/user/storyplan-config/upsert-by-name

Get homepage prompts

Path Parameters

api-version-string

required
GET
/prompts
1

Delete a document from project

Query Parameters

document-id

required

Path Parameters

api-version-string

required
DELETE
/project/docs
1

Retrieve a Capitol project by user

Fetches a specific Capitol project using the project ID. A project contains various documents and sources uploaded or created by the user.

Query Parameters

project-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/project
1

Update a Capitol project

Updates a Capitol project with new or existing details, including its name and sources (PDFs, images, URLs).

Path Parameters

api-version-string

required, string, default: latest

Request Body

project-id

required, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

project-id

required, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

project-id

required, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

project-id

required, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string
PUT
/api/:api-version-string/project
1
EXAMPLE BODY
{
  "project-id": "461c0902-ad5b-0f32-faf8-e14596136459",
  "pdf-sources": [
    "esse Lorem nulla mollit"
  ],
  "image-sources": [
    "cillum",
    null,
    "incididunt fugiat minim occaecat"
  ],
  "url-sources": [
    "qui nulla nisi anim exercitation",
    "qui culpa occaecat",
    "sunt labore ut id velit"
  ],
  "project-name": "Duis ex dolor id Ut"
}

Delete a Capitol project

Deletes a specified Capitol project from the user's account based on the project ID.

Query Parameters

project-id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/project
1

Create a new Capitol project

Creates a new Capitol project where users can add sources (PDFs, images, URLs) and documents.

Path Parameters

api-version-string

required, string, default: latest

Request Body

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string

pdf-sources

optional, array

image-sources

optional, array

url-sources

optional, array

project-name

optional, string
POST
/api/:api-version-string/project
1
EXAMPLE BODY
{
  "pdf-sources": [
    null,
    "labore cupidatat occaecat aliqua",
    null
  ],
  "image-sources": [
    "dolor",
    "eu enim pariatur proident"
  ],
  "url-sources": [
    "quis nulla",
    null,
    null,
    "non enim nulla",
    null
  ]
}

List all Capitol projects for a user

Retrieves a list of all Capitol projects associated with the user, optionally including sources and allowing pagination through limit and offset parameters.

Query Parameters

sources

optional, boolean

limit

optional, integer

offset

optional, integer

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/project/list
1

List all Capitol documents within a project

Fetches all documents under a specified project ID, displaying all documents associated with the project.

Query Parameters

project-id

optional, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/project/docs/list
1

Retrieve Capitol documents within a specific project

Retrieves documents within a given project, with optional pagination using offset. Allows specifying a project ID.

Query Parameters

offset

optional, integer

project-id

optional, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/project/docs
1

Move a document between projects

Transfers a document from one project to another, specified by document ID, origin project ID, and target project ID.

Query Parameters

document-id

required, string

origin-project-id

optional, string

project-id

required, string

Path Parameters

api-version-string

required, string, default: latest
PUT
/api/:api-version-string/project/docs
1

Remove a document from a project

Deletes a specified document from a project based on document ID.

Query Parameters

document-id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/project/docs
1

Retrieve sources within a project

Fetches all sources (PDFs, images, URLs) used in the documents of a specified project.

Query Parameters

project-id

optional, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/project/source
1

Copy a source to another project

Copies a source (PDF, image, or URL) from one project to another, specified by origin project ID, target project ID, and source type.

Query Parameters

origin-project-id

required, string

project-id

required, string

source-id

required, string

type

required, string

Path Parameters

api-version-string

required, string, default: latest
PUT
/api/:api-version-string/project/source
1

Delete a source from a project

Removes a specific source from a project, based on project ID, source ID, and source type.

Query Parameters

project-id

required, string

source-id

required, string

type

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/project/source
1

Fetch capitol events

Query Parameters

story-id

required

Path Parameters

api-version-string

required
GET
/events
1

Update a capitol event

Path Parameters

api-version-string

required

body

required, object
PATCH
/events
1

Delete a capitol event

Query Parameters

event-id

required

story-id

required

Path Parameters

api-version-string

required
DELETE
/events
1

Create a new capitol event

Path Parameters

api-version-string

required

body

required, object
POST
/events
1

Perform a bulk update operation

Path Parameters

api-version-string

required

body

required, object
PATCH
/events/bulk
1

Re order the capitol events

Path Parameters

api-version-string

required

body

required, object
POST
/events/reorder
1

Turn a event of a image into a test.

Path Parameters

api-version-string

required

body

required, object
POST
/events/turn-into
1

Retrieve Capitol events for a specific document

Fetches a list of events associated with a specific document (or story) by story-id. A document consists of multiple events, and may have several versions or iterations called drafts. Events can be modified individually or at the document level if changes are made across drafts.

Query Parameters

story-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/events
1

Delete a specific Capitol event

Removes a particular event from a document draft, using the event-id and story-id to identify the specific event to delete.

Query Parameters

event-id

required, string

story-id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/events
1

Execute a bulk update of events within a document draft

Performs a bulk update across multiple events within a specified draft of a document, identified by draft depth. This operation can include modifying event content, adjusting draft-specific parameters, and adding or removing events. Events to delete can also be specified in the request.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

draft-depth

optional, integer
draft-id
optional

events

required, array

events-to-delete

optional, array

story-id

required, string

draft-depth

optional, integer
draft-id
optional

events

required, array

events-to-delete

optional, array

story-id

required, string

draft-depth

optional, integer
draft-id
optional

events

required, array

events-to-delete

optional, array

story-id

required, string

draft-depth

optional, integer
draft-id
optional

events

required, array

events-to-delete

optional, array
PATCH
/api/:api-version-string/events/bulk
1
EXAMPLE BODY
{
  "story-id": "5aa86aa1-38ac-e0bc-56e5-135b249a60dc",
  "draft-depth": 86751985,
  "events": [
    {
      "event-id": "54dca7d7-329f-ec8c-5ddb-9e5bb820af50",
      "block-id": "0555608c-d34c-6770-09f9-49ab04c2112b",
      "content": {}
    },
    {
      "event-id": "9f92ac65-c916-c66e-bf24-caaa0dd0005c",
      "block-id": "7da4cf02-d906-ae41-7686-1888d522e54c",
      "content": {}
    },
    {
      "event-id": "07a6c0f7-d76a-92d6-9e58-60bed68c1a87",
      "block-id": "9cf89964-dc10-adcb-f87e-ccc4ea6d4d52",
      "content": {}
    }
  ]
}

Transform an event block into a different block type

Modifies the type of an event block within a document, allowing any block type to be converted into another (e.g., from image to text or vice versa). This endpoint accepts parameters for customizing output type, subtype, and optionally specifying the draft and position within the document structure.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

draft-id

optional, string

event-id

required, string

block-id

required, string

output-sub-type

required, string

output-type

required, string

event-id-below

optional, string

story-id

required, string

draft-id

optional, string

event-id

required, string

block-id

required, string

output-sub-type

required, string

output-type

required, string

event-id-below

optional, string

story-id

required, string

draft-id

optional, string

event-id

required, string

block-id

required, string

output-sub-type

required, string

output-type

required, string

event-id-below

optional, string

story-id

required, string

draft-id

optional, string

event-id

required, string

block-id

required, string

output-sub-type

required, string

output-type

required, string

event-id-below

optional, string
POST
/api/:api-version-string/events/turn-into
1
EXAMPLE BODY
{
  "story-id": "ebd9eb64-d188-a31e-cd0e-0bca5d237f47",
  "draft-id": "8e971c7a-c9af-b621-5a7f-faddea91fe85",
  "event-id": "ace8ca3c-7651-909b-f26f-5e7207b76457",
  "block-id": "ab643aa3-618f-d321-e1a9-e616170d2da9",
  "output-sub-type": "nostrud",
  "output-type": "mollit irure velit dolore sunt",
  "event-id-below": "c94ffa49-8cf1-f488-5cd9-e0167aae9d31"
}

Retrieve current user

Path Parameters

api-version-string

required
GET
/user/current-user
1

Retrieve current user

Retrieves the details of the currently authenticated user.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/current-user
1

Authenticate current user with auth code

Authenticates the current user using an authorization code.

Path Parameters

api-version-string

required, string, default: latest

Request Body

referred-by

optional, string

code

required, string

referred-by

optional, string

code

required, string

referred-by

optional, string

code

required, string

referred-by

optional, string

code

required, string
POST
/api/:api-version-string/user/current-user
1
EXAMPLE BODY
{
  "referred-by": "occaecat sed laborum",
  "code": "nulla in"
}

It creates a WS adress for processing user's pdfs and urls.

Path Parameters

api-version-string

required

body

required, object
POST
/user/sources/ws
1

Process the user sources.

Path Parameters

api-version-string

required

body

required
POST
/user/sources/upload-source
1

Retrieve sources by story id

Query Parameters

story-id

required

Path Parameters

api-version-string

required
GET
/user/sources/story
1

Create a WebSocket address for PDF and URL processing

Generates a WebSocket (WS) address for processing user-uploaded PDFs and URLs, enabling real-time communication for source processing.

Path Parameters

api-version-string

required, string, default: latest

Request Body

ws-uuid

required, string

ws-uuid

required, string

ws-uuid

required, string

ws-uuid

required, string
POST
/api/:api-version-string/user/sources/ws
1
EXAMPLE BODY
{
  "ws-uuid": "13acc852-c4b0-df63-d233-aabad51a7551"
}

Upload and process user sources asynchronously

Accepts and processes user-provided sources (PDFs, URLs, etc.) asynchronously. Files are temporarily stored for 1 hour during processing. Returns a WebSocket URL for real-time processing status updates.

Path Parameters

api-version-string

required, string, default: latest

Request Body

Unnamed Property

Unnamed Property

Unnamed Property

Unnamed Property

POST
/api/:api-version-string/user/sources/upload-source
1
EXAMPLE BODY
{}

Process JSON or URL user sources

Processes user-provided source data in JSON format, including source IDs, filenames, and data details, for seamless synchronization. Also accepts URLs as source-urls.

Path Parameters

api-version-string

required, string, default: latest

Request Body

source-id

required, string

filename

required, string

generate-embedding

optional, boolean

data

optional, object

source-url

optional, string

source-id

required, string

filename

required, string

generate-embedding

optional, boolean

data

optional, object

source-url

optional, string

source-id

required, string

filename

required, string

generate-embedding

optional, boolean

data

optional, object

source-url

optional, string

source-id

required, string

filename

required, string

generate-embedding

optional, boolean

data

optional, object

source-url

optional, string
POST
/api/:api-version-string/user/sources/upload-source/sync
1
EXAMPLE BODY
{
  "source-id": "c57ddc0b-f17d-030d-3283-4116ae897bb2",
  "filename": "eiusmod"
}

Process files user's sources synchronously

Processes user-provided source data in PDF or Image format, including source IDs, filenames, and data details, for seamless synchronization.

Path Parameters

api-version-string

required, string, default: latest

Request Body

source-id

required, string

filename

required, string

file

required
POST
/api/:api-version-string/user/sources/upload-source/file
1

Retrieve sources by story ID

Fetches all sources associated with a specified story, identified by story ID, for streamlined access to related content.

Query Parameters

story-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/sources/story
1

Validate YouTube link

Checks if a given YouTube link is valid and can be processed, verifying compatibility for source integration.

Path Parameters

api-version-string

required, string, default: latest

Request Body

url

required, string

url

required, string

url

required, string

url

required, string
POST
/api/:api-version-string/user/sources/youtube
1
EXAMPLE BODY
{
  "url": "exercitation ullamco Duis quis ut"
}

Retrieve user default story configurations

Query Parameters

user-id

required

Path Parameters

api-version-string

required
GET
/user/storyplan-config/default
1

Fetch a particular story

Query Parameters

share-id

optional

id

optional

unfurl

optional

Path Parameters

api-version-string

required
GET
/stories/story
1

Update a story in the DB

Path Parameters

api-version-string

required

body

required, object
PUT
/stories/story
1

Delete a story from the DB

Query Parameters

id

required

Path Parameters

api-version-string

required
DELETE
/stories/story
1

Commit a new story to the DB

Path Parameters

api-version-string

required

body

required, object
POST
/stories/story
1

Fetch mini info of a particular story

Query Parameters

story-id

required

migrated

optional

Path Parameters

api-version-string

required
GET
/stories/mini
1

Fetch a particular story

Query Parameters

id

required

Path Parameters

api-version-string

required
GET
/stories/story/events
1

Patch the story visibility.

Path Parameters

api-version-string

required

body

required, object
PATCH
/stories/visibility
1

Fork a story

Path Parameters

api-version-string

required

body

required, object
POST
/stories/fork
1

Retrieve a specific story

Fetches the details of a story based on either share ID or story ID, with an optional parameter for unfurling.

Query Parameters

share-id

optional, string

id

optional, string

unfurl

optional

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/stories/story
1

Update an existing story

Updates a story in the database with modified details and an option to regenerate the unfurl.

Path Parameters

api-version-string

required, string, default: latest

Request Body

updated-story

required, object

regenerate-unfurl

required, boolean

updated-story

required, object

regenerate-unfurl

required, boolean

updated-story

required, object

regenerate-unfurl

required, boolean

updated-story

required, object

regenerate-unfurl

required, boolean
PUT
/api/:api-version-string/stories/story
1
EXAMPLE BODY
{
  "updated-story": {
    "id": "3462429d-9fe0-ee41-658e-044925d6a007",
    "active-draft-id": "352db83b-a6f6-4f33-62f7-e893a67a9a04"
  },
  "regenerate-unfurl": true
}

Delete a story

Removes a story from the database, identified by its ID.

Query Parameters

id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/stories/story
1

Save a new story

Creates and saves a new story in the database with the provided content.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

active-draft-id

optional, string

version

required, string, minimum length of 4

perms

optional

headline

required
headline-id
optional
headline-event-id
optional

authors

required

chapters

required, array, maximum of 1 items, minimum of 1 items

created-at

optional, string

updated-at

optional, string

read-only

optional, boolean

is-active

optional, boolean

is-public

optional, boolean
is-llm-generating
optional
last-processed-llm-event-id
optional

views-count

optional, integer

like-count

optional, integer
story-plan
optional

topics

optional, array of strings

has-liked-by-me

optional, boolean

processed-llm-event-ids

optional
unfurl-image-url
optional

capitol-rank

optional
active-section-index
optional

banner

optional
parent-story-id
optional
current-depth-level
optional
project-id
optional

id

required, string

active-draft-id

optional, string

version

required, string, minimum length of 4

perms

optional

headline

required
headline-id
optional
headline-event-id
optional

authors

required

chapters

required, array, maximum of 1 items, minimum of 1 items

created-at

optional, string

updated-at

optional, string

read-only

optional, boolean

is-active

optional, boolean

is-public

optional, boolean
is-llm-generating
optional
last-processed-llm-event-id
optional

views-count

optional, integer

like-count

optional, integer
story-plan
optional

topics

optional, array of strings

has-liked-by-me

optional, boolean

processed-llm-event-ids

optional
unfurl-image-url
optional

capitol-rank

optional
active-section-index
optional

banner

optional
parent-story-id
optional
current-depth-level
optional
project-id
optional

id

required, string

active-draft-id

optional, string

version

required, string, minimum length of 4

perms

optional

headline

required
headline-id
optional
headline-event-id
optional

authors

required

chapters

required, array, maximum of 1 items, minimum of 1 items

created-at

optional, string

updated-at

optional, string

read-only

optional, boolean

is-active

optional, boolean

is-public

optional, boolean
is-llm-generating
optional
last-processed-llm-event-id
optional

views-count

optional, integer

like-count

optional, integer
story-plan
optional

topics

optional, array of strings

has-liked-by-me

optional, boolean

processed-llm-event-ids

optional
unfurl-image-url
optional

capitol-rank

optional
active-section-index
optional

banner

optional
parent-story-id
optional
current-depth-level
optional
project-id
optional

id

required, string

active-draft-id

optional, string

version

required, string, minimum length of 4

perms

optional

headline

required
headline-id
optional
headline-event-id
optional

authors

required

chapters

required, array, maximum of 1 items, minimum of 1 items

created-at

optional, string

updated-at

optional, string

read-only

optional, boolean

is-active

optional, boolean

is-public

optional, boolean
is-llm-generating
optional
last-processed-llm-event-id
optional

views-count

optional, integer

like-count

optional, integer
story-plan
optional

topics

optional, array of strings

has-liked-by-me

optional, boolean

processed-llm-event-ids

optional
unfurl-image-url
optional

capitol-rank

optional
active-section-index
optional

banner

optional
parent-story-id
optional
current-depth-level
optional
project-id
optional
POST
/api/:api-version-string/stories/story
1
EXAMPLE BODY
{
  "id": "296ab4e4-4b2a-cd0a-d6a0-0633552a7f8c",
  "version": "elit fugiat",
  "headline": {},
  "authors": {},
  "chapters": [
    {
      "id": "9cb450ff-a45b-a763-7d37-cd07b9ad0a8e",
      "block-type": "chapter",
      "sections": [
        {
          "block-type": "section",
          "id": "e25a779a-2914-9672-6591-4f3583d85837",
          "title": {},
          "intro": {},
          "palette": "et pariatur minim in eu",
          "show-headings": true,
          "is-collpased": false,
          "subsections": [
            {
              "block-type": "subsection",
              "id": "576186fa-6fd7-8c9e-2d4f-7773f14ff703",
              "row": "2",
              "column": "1",
              "blocks": [
                {
                  "block-type": "metrics",
                  "id": "3788c2f8-9684-0d2e-7616-c65c93330733",
                  "metrics": [
                    {
                      "data": 65320901.178783774,
                      "descriptor": null,
                      "icon": {
                        "source": "aute"
                      }
                    },
                    {
                      "data": -71648657.52655265,
                      "descriptor": "ullamco",
                      "icon": {
                        "source": "proident culpa reprehenderit cupidatat laboris"
                      }
                    }
                  ],
                  "source-ids": [
                    "commodo incididunt dolor dolore Excepteur"
                  ],
                  "llm-selection": true,
                  "event-id": "ipsum sint ex",
                  "event-block-index": -94401707.00581576
                },
                {
                  "block-type": "table",
                  "id": "51dbb44b-52f6-8916-dbda-11ad04d8119b",
                  "event-id": "culpa adipisicing",
                  "data": []
                },
                {
                  "block-type": "metrics",
                  "id": "25b1efa3-655f-723c-5552-c3d1f24248a5",
                  "metrics": [
                    {
                      "data": 6807276.710183442,
                      "descriptor": "ex magna dolore",
                      "icon": {
                        "source": "nulla ut",
                        "url": "irure enim esse tempor ex"
                      }
                    },
                    {
                      "data": -86509999.75181884,
                      "descriptor": null,
                      "icon": {
                        "source": "ex"
                      }
                    }
                  ],
                  "source-ids": [
                    "laborum"
                  ],
                  "llm-selection": false,
                  "event-id": "in esse",
                  "event-block-index": 86621701.87617376
                },
                {
                  "block-type": "text",
                  "id": "c5e0af6a-e0a4-a391-d47b-94ed43b26009",
                  "variant": "do fugiat exercitation",
                  "source-ids": [
                    "in ex exercitation",
                    "velit sit ut"
                  ],
                  "bans": [
                    {
                      "data": -96312916.5439836,
                      "descriptor": "officia sit consectetur",
                      "icon": {
                        "source": "Lorem",
                        "url": "tempor aute est sint"
                      }
                    },
                    {
                      "data": "velit eiusmod dolore",
                      "descriptor": "laborum non dolore",
                      "icon": {
                        "source": "ut dolor id"
                      }
                    }
                  ],
                  "event-id": "reprehenderit Lorem",
                  "event-block-index": 97694613.15815243,
                  "is-new": true
                }
              ]
            },
            {
              "block-type": "subsection",
              "id": "39d10901-8b4d-12c1-e947-769b02c24ba9",
              "row": "1",
              "column": "1",
              "blocks": [
                {
                  "block-type": "image",
                  "id": "6f7d8ed2-fcaa-fdca-4676-db22997912eb",
                  "src": "veniam officia aute irure laboris",
                  "width": -75977803,
                  "height": 85216791,
                  "caption": "cupidatat dolor deserunt sit",
                  "llm-selection": true,
                  "show-caption": false,
                  "source-ids": [
                    "nisi sed elit eiusmod dolore"
                  ],
                  "event-block-index": 76895709.57679597,
                  "image-style": null,
                  "error-code": null
                },
                {
                  "block-type": "quote",
                  "id": "177b6881-e9a6-5802-fbfe-1b18c0d3372d",
                  "quote": "labore dolor",
                  "source-ids": [],
                  "event-id": "ut quis",
                  "event-block-index": -37269697.699021
                },
                {
                  "block-type": "table",
                  "id": "5d987311-e975-ff2c-143e-3029c48093e3",
                  "event-id": "cupidatat ad mollit anim",
                  "event-block-index": -71348546.55319196,
                  "data": []
                },
                {
                  "block-type": "ai_generated_chart",
                  "id": "066c7738-3673-28ae-653d-1ef2af36f931",
                  "event-id": "nulla ex",
                  "url": "dolore sint mollit deserunt",
                  "event-block-index": 8599172.807103723,
                  "llm-selection": true,
                  "source-ids": [
                    "elit",
                    "deserunt et aute elit dolor",
                    "do ipsum aute"
                  ]
                }
              ]
            }
          ],
          "created-at": "sint dolore qui exercitation",
          "remix-suggestions": [
            "consectetur mollit velit"
          ],
          "topics": [
            "et dolor aliqua labore eiusmod",
            "adipisicing non dolore pariatur laboris",
            "proident ut aliquip",
            "ex cupidatat ut mollit"
          ]
        }
      ]
    }
  ]
}

Fetch story events

Retrieves the sequence of events for a particular story, identified by story ID.

Query Parameters

id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/stories/story/events
1

Fork an existing story

Creates an independent copy of an existing story that can be modified and expanded upon by the user, regardless of whether they are the original author. The forked story is detached from the original author_id, allowing full editing freedom without affecting the original story.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

story-id

required, string

story-id

required, string

story-id

required, string
POST
/api/:api-version-string/stories/story/fork
1
EXAMPLE BODY
{
  "story-id": "ba8f88e0-6121-e0a0-7483-7751dbcaa78a"
}

Retry a failing story/block

Retries a story that failed to generate due to an error, allowing the user to retry the generation process with the same parameters and configurations.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

draft-id

required, string

event-id

optional, string

error-type

required, string

payload

required, object

story-id

required, string

draft-id

required, string

event-id

optional, string

error-type

required, string

payload

required, object

story-id

required, string

draft-id

required, string

event-id

optional, string

error-type

required, string

payload

required, object

story-id

required, string

draft-id

required, string

event-id

optional, string

error-type

required, string

payload

required, object
POST
/api/:api-version-string/stories/story/retry
1
EXAMPLE BODY
{
  "story-id": "19922fd1-004a-93e1-73b8-f191b0c31ae5",
  "draft-id": "18395cad-4607-7964-a1fa-9eea1ac4fae9",
  "error-type": "voluptate aute ea aliquip dolor",
  "payload": {}
}

Fetch minimal story information

Returns minimal information for a story, including ID and migration status, for lightweight requests.

Query Parameters

story-id

required, string

migrated

optional, boolean

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/stories/mini
1

Toggle story visibility

Updates the visibility status of a story, allowing it to be made public or private based on the user's preference.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

story-id

required, string

story-id

required, string

story-id

required, string
PATCH
/api/:api-version-string/stories/visibility
1
EXAMPLE BODY
{
  "story-id": "3c42da85-5223-8590-5fe2-5e200b404d7e"
}

Duplicate a block in a story.

Path Parameters

api-version-string

required

body

required, object
POST
/stories/fork-block
1

Remix a complete story.

Path Parameters

api-version-string

required

body

required, object
POST
/stories/remix/story
1

Remix a complete story

Creates a new version of a story by remixing it with optional user-defined configurations and a specified plan.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string
parent-draft-id
optional

user-config-params

optional

story-plan-config-id

optional, string

story-id

required, string
parent-draft-id
optional

user-config-params

optional

story-plan-config-id

optional, string

story-id

required, string
parent-draft-id
optional

user-config-params

optional

story-plan-config-id

optional, string

story-id

required, string
parent-draft-id
optional

user-config-params

optional

story-plan-config-id

optional, string
POST
/api/:api-version-string/stories/remix/story
1
EXAMPLE BODY
{
  "story-id": "b2186988-9e5b-a728-db8e-8f476ca8e685"
}

Fetch a list of stories. Based on the search params and in the filters.

Query Parameters

sort-by

required

topic-values

optional

search-value

optional

modes

optional

own

optional

private

optional

delete

optional

limit

optional

offset

optional

Path Parameters

api-version-string

required
GET
/stories/feed
1

Request chat_id and socket_address

Path Parameters

api-version-string

required

body

required, object
POST
/chat/async
1

Initiate document generation and obtain streaming address

Initiates the document generation process and returns a WebSocket address for streaming events, including segments of AI-generated content. The request body may include a 'story plan'—an object containing customization instructions such as length, model selection, use of images or charts, and more. You must provide either a story plan or a story plan ID

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

user-config-params

optional, object

story-plan-config-id

optional, string

source-ids

optional, array of strings

story-id

required, string

user-config-params

optional, object

story-plan-config-id

optional, string

source-ids

optional, array of strings

story-id

required, string

user-config-params

optional, object

story-plan-config-id

optional, string

source-ids

optional, array of strings

story-id

required, string

user-config-params

optional, object

story-plan-config-id

optional, string

source-ids

optional, array of strings
POST
/api/:api-version-string/chat/async
1
EXAMPLE BODY
{
  "story-id": "b5dc8213-7897-9443-0eff-524d8875772b"
}

Request prompt suggestions for Block level chat

Path Parameters

api-version-string

required

body

required, object
POST
/chat/block-suggestions
1

Retrieve chat history for a story or component

Retrieve the complete chat history for a specific story or a component within a story. To access the entire story-level chat, omit the component-id parameter in the request.

Query Parameters

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

component-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Component ID

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/chat
1

Submit a user message and receive an agent’s response

Sends a new user message to the chat and returns an automated response from the agent.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

draft-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Draft ID

draft-number

optional, integer, default: 0

Draft number

block-id
optional, default: 00000000-0000-0000-0000-000000000000

Block ID

event-id
optional, default: 00000000-0000-0000-0000-000000000000

Event ID

user-chat-message

optional, string, default: User chat message

User chat message

user-chat-params

optional, object, default: {}

User chat params

new-block

optional, boolean, default: false

New block

new-block-params

optional, object, default: {}

New block params

cyoa

optional, boolean, default: false

CYOA

options

optional, array, default: []

Options

custom-options

optional, array

Custom options

topics

optional, array of strings

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

draft-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Draft ID

draft-number

optional, integer, default: 0

Draft number

block-id
optional, default: 00000000-0000-0000-0000-000000000000

Block ID

event-id
optional, default: 00000000-0000-0000-0000-000000000000

Event ID

user-chat-message

optional, string, default: User chat message

User chat message

user-chat-params

optional, object, default: {}

User chat params

new-block

optional, boolean, default: false

New block

new-block-params

optional, object, default: {}

New block params

cyoa

optional, boolean, default: false

CYOA

options

optional, array, default: []

Options

custom-options

optional, array

Custom options

topics

optional, array of strings

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

draft-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Draft ID

draft-number

optional, integer, default: 0

Draft number

block-id
optional, default: 00000000-0000-0000-0000-000000000000

Block ID

event-id
optional, default: 00000000-0000-0000-0000-000000000000

Event ID

user-chat-message

optional, string, default: User chat message

User chat message

user-chat-params

optional, object, default: {}

User chat params

new-block

optional, boolean, default: false

New block

new-block-params

optional, object, default: {}

New block params

cyoa

optional, boolean, default: false

CYOA

options

optional, array, default: []

Options

custom-options

optional, array

Custom options

topics

optional, array of strings

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

draft-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Draft ID

draft-number

optional, integer, default: 0

Draft number

block-id
optional, default: 00000000-0000-0000-0000-000000000000

Block ID

event-id
optional, default: 00000000-0000-0000-0000-000000000000

Event ID

user-chat-message

optional, string, default: User chat message

User chat message

user-chat-params

optional, object, default: {}

User chat params

new-block

optional, boolean, default: false

New block

new-block-params

optional, object, default: {}

New block params

cyoa

optional, boolean, default: false

CYOA

options

optional, array, default: []

Options

custom-options

optional, array

Custom options

topics

optional, array of strings
POST
/api/:api-version-string/chat
1
EXAMPLE BODY
{
  "story-id": "00000000-0000-0000-0000-000000000000",
  "user-chat-params": {},
  "cyoa": false
}

Reset chat history for a specific block

Notifies the backend to reset the chat history for a designated block based on recent user actions.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

draft-id

required, string

block-id

required, string

story-id

required, string

draft-id

required, string

block-id

required, string

story-id

required, string

draft-id

required, string

block-id

required, string

story-id

required, string

draft-id

required, string

block-id

required, string
POST
/api/:api-version-string/chat/reset-block-chat
1
EXAMPLE BODY
{
  "story-id": "16ccefcc-4bdb-1f6d-cbb5-367aec57e22c",
  "draft-id": "0007c6bc-7c52-2194-e960-4171af9ff1ac",
  "block-id": "e471b778-5c51-5bfb-6187-6badb7df15a0"
}

Request prompt suggestions for a content block

Generates a list of suggested prompts for modifying a specific content block, such as making a text block longer or more detailed.

Path Parameters

api-version-string

required, string, default: latest

Request Body

block-id
optional

block-subtype

optional, string

block-type

optional, string

new-block

optional, boolean

local-context

optional, array
story-id
required
event-id
required
draft-id
optional
block-id
optional

block-subtype

optional, string

block-type

optional, string

new-block

optional, boolean

local-context

optional, array
story-id
required
event-id
required
draft-id
optional
block-id
optional

block-subtype

optional, string

block-type

optional, string

new-block

optional, boolean

local-context

optional, array
story-id
required
event-id
required
draft-id
optional
block-id
optional

block-subtype

optional, string

block-type

optional, string

new-block

optional, boolean

local-context

optional, array
story-id
required
event-id
required
draft-id
optional
POST
/api/:api-version-string/chat/block-suggestions
1
EXAMPLE BODY
{
  "block-id": "in cillum",
  "block-type": "aute Excepteur",
  "new-block": true,
  "local-context": [],
  "story-id": "643a9a24-bd8d-b4fd-4d7f-0314fd5c5dce",
  "event-id": "d70b4a40-b9d2-dd5f-3d77-b84a18daa4d4"
}

Stop the ongoing story generation

Stops the story generation process based on the provided story-id parameter.

Path Parameters

api-version-string

required, string, default: latest

Request Body

external-id

required, string

external-id

required, string

external-id

required, string

external-id

required, string
POST
/api/:api-version-string/chat/cancel
1
EXAMPLE BODY
{
  "external-id": "1bd50ca9-4f1b-b6f6-f375-c2064d25d59c"
}

Report the latest API version.

Returns the current API version.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/api-version
1

Fake search

Query Parameters

title

required, string, default: Politico recent news.

User query

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/integration/sources
1

Fake upload sources

Path Parameters

api-version-string

required, string, default: latest

Request Body

source-uuid

required, string

ws-uuid

required, string

project-id

optional, string

Project ID

source-uuid

required, string

ws-uuid

required, string

project-id

optional, string

Project ID

source-uuid

required, string

ws-uuid

required, string

project-id

optional, string

Project ID

source-uuid

required, string

ws-uuid

required, string

project-id

optional, string

Project ID

POST
/api/:api-version-string/integration/upload
1
EXAMPLE BODY
{
  "source-uuid": "e1afc49f-4432-aa5a-dd96-818fa5cc98f8",
  "ws-uuid": "2da47caa-3dfb-9906-e113-8a0e5eb253d4"
}

Retrieve Tako chart preview link

Fetches a preview link for a chart generated by Tako, an external chart generation service. This link provides a visual preview of the requested chart based on the specified parameters.

Query Parameters

pub-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/tako
1

Retrieve Tako chart preview link (v2)

Fetches a preview link for a chart generated by Tako using version 2 of the API. This was created as a POC of capitol versioning.

Query Parameters

pub-id

required, string

silly-key

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/tako/v2
1

Submit Google Drive authorization code for the current user

Sends the user’s authorization code to Google Drive to establish access. This step is required to enable exporting stories to Google Drive.

Path Parameters

api-version-string

required, string, default: latest

Request Body

user-id

required, string

code

required, string

user-id

required, string

code

required, string

user-id

required, string

code

required, string

user-id

required, string

code

required, string
POST
/api/:api-version-string/drive/auth
1
EXAMPLE BODY
{
  "user-id": "73a32298-7033-7f9d-2855-ae5b0e0009ee",
  "code": "cillum"
}

Retrieve Google Drive accounts authorized by the user

Fetches a list of Google Drive accounts that the user has authorized, allowing verification of linked accounts.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/drive/user
1

Remove Google Drive authorizations for the user

Deletes all Google Drive account authorizations for the user, revoking access for exporting stories.

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/drive/user
1

Export a story to Google Drive

Takes a story ID and exports the corresponding story to the user’s Google Drive account. Requires prior authorization from the user to access Google Drive.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string

draft-id

optional, string

story-id

required, string

draft-id

optional, string

story-id

required, string

draft-id

optional, string

story-id

required, string

draft-id

optional, string
POST
/api/:api-version-string/drive/export
1
EXAMPLE BODY
{
  "story-id": "4e203d4e-2d55-8478-52c8-cc9741658921",
  "draft-id": "5cd8b02c-9f5a-c877-d4e5-33a4493bd13c"
}

get api keys

get api keys for org

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/api-keys
1

post an api key

sets an api for organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

key

required, string

value

required, string

key

required, string

value

required, string

key

required, string

value

required, string

key

required, string

value

required, string
POST
/api/:api-version-string/api-keys
1
EXAMPLE BODY
{
  "key": "reprehenderit dolore consectetur et ad",
  "value": "labore aliquip enim Lorem non"
}

Fetch the details of the current organization

Fetches the details of the current organization

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org
1

Update the details of an organization

Updates the details of an organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

name

optional, string

image-url

optional, string

name

optional, string

image-url

optional, string

name

optional, string

image-url

optional, string

name

optional, string

image-url

optional, string
PATCH
/api/:api-version-string/org
1
EXAMPLE BODY
{
  "name": "nisi culpa est in"
}

Create a new organization

Creates a new organization for the user

Path Parameters

api-version-string

required, string, default: latest

Request Body

name

required, string

image-url

optional, string

name

required, string

image-url

optional, string

name

required, string

image-url

optional, string

name

required, string

image-url

optional, string
POST
/api/:api-version-string/org
1
EXAMPLE BODY
{
  "name": "nisi culpa qui",
  "image-url": "dolore"
}

Fetch all organizations

Fetches all organizations

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/all
1

Upload a logo

Allows the user to upload a logo.

Path Parameters

api-version-string

required, string, default: latest

Request Body

file

required
POST
/api/:api-version-string/org/logo
1

Fetch all api keys for the organization

Fetches all api keys for the organization

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/key
1

Update the name of an api key

Updates the name of an api key

Path Parameters

api-version-string

required, string, default: latest

Request Body

api-key-id

required, string

name

optional, string

domain

optional, string

api-key-id

required, string

name

optional, string

domain

optional, string

api-key-id

required, string

name

optional, string

domain

optional, string

api-key-id

required, string

name

optional, string

domain

optional, string
PATCH
/api/:api-version-string/org/key
1
EXAMPLE BODY
{
  "api-key-id": "c7cbf999-4999-a94d-e68c-9f0695252e80",
  "name": "amet ex",
  "domain": "tempor est adipisicing occaecat culpa"
}

Delete an api key by id

Deletes an api key by id

Query Parameters

api-key-id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/org/key
1

Create a new api key for the organization

Creates a new api key for the organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

name

required, string

domain

required, string

name

required, string

domain

required, string

name

required, string

domain

required, string

name

required, string

domain

required, string
POST
/api/:api-version-string/org/key
1
EXAMPLE BODY
{
  "name": "voluptate adipisicing",
  "domain": "non adipisicing culpa Lorem aliquip"
}

Fetch all models for the organization

Fetches all models for the organization

Query Parameters

organization-id

optional, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/models
1

Upsert the primary and seconday model for an organization

Upsert the primary and seconday model for an organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

organization-id

optional, string

primary-model

required, string

secondary-model

required, string

organization-id

optional, string

primary-model

required, string

secondary-model

required, string

organization-id

optional, string

primary-model

required, string

secondary-model

required, string

organization-id

optional, string

primary-model

required, string

secondary-model

required, string
POST
/api/:api-version-string/org/models
1
EXAMPLE BODY
{
  "organization-id": "9df61691-35ee-b6df-051c-a33131c2b2d2",
  "primary-model": "voluptate consectetur pariatur dolor",
  "secondary-model": "nostrud enim consequat Excepteur eu"
}

Fetch all models available for the organization

Fetches all models for the organization

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/models/list
1

Fetch all members of the organization

Fetches all members of the organization

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/member
1

Remove a member from the organization

Removes a member from the organization

Query Parameters

member-id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/org/member
1

Add a member to the organization

Adds a member to the organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

member-id

required, string

role

optional, string

member-id

required, string

role

optional, string

member-id

required, string

role

optional, string

member-id

required, string

role

optional, string
POST
/api/:api-version-string/org/member
1
EXAMPLE BODY
{
  "member-id": "0fc1da0c-3b3a-d82c-f976-8c903b131d09",
  "role": "fugiat voluptate amet deserunt"
}

Fetch all members of the organization

Fetches all members of the organization

Query Parameters

organization-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/org/member/list
1

Invite a member to the organization

Invites a member to the organization

Path Parameters

api-version-string

required, string, default: latest

Request Body

organization-id

optional, string

email

required, string

role

optional, string

organization-id

optional, string

email

required, string

role

optional, string

organization-id

optional, string

email

required, string

role

optional, string

organization-id

optional, string

email

required, string

role

optional, string
POST
/api/:api-version-string/org/member/invite
1
EXAMPLE BODY
{
  "organization-id": "b49ae95e-2ccc-eb25-f290-70060c958b50",
  "email": "sit dolor"
}

Validate an invite code

Validates an invite code

Path Parameters

api-version-string

required, string, default: latest

Request Body

email

required, string

code

required, string

email

required, string

code

required, string

email

required, string

code

required, string

email

required, string

code

required, string
POST
/api/:api-version-string/org/member/invite/validate
1
EXAMPLE BODY
{
  "email": "sit ipsum enim",
  "code": "laboris"
}

Get all guardrail config by org

Retrieves all guardrail configurations for the organization.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/configs/guardrails
1

Update a specific guardrail config

Updates a guardrail configuration using the provided ID.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

name

optional, string, default: Guardrail

Name

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

active

optional, boolean, default: true

Active

examples

optional, string, default: Guardrail examples

Examples

id

required, string

name

optional, string, default: Guardrail

Name

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

active

optional, boolean, default: true

Active

examples

optional, string, default: Guardrail examples

Examples

id

required, string

name

optional, string, default: Guardrail

Name

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

active

optional, boolean, default: true

Active

examples

optional, string, default: Guardrail examples

Examples

id

required, string

name

optional, string, default: Guardrail

Name

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

active

optional, boolean, default: true

Active

examples

optional, string, default: Guardrail examples

Examples

PATCH
/api/:api-version-string/configs/guardrails
1
EXAMPLE BODY
{
  "id": "ecc32c5b-cb9d-ad91-81b1-c403034dd7a7",
  "name": "Guardrail",
  "description": "Guardrail description",
  "pass-criteria": "Guardrail pass criteria",
  "fail-criteria": "Guardrail fail criteria",
  "active": true,
  "examples": "Guardrail examples"
}

Create a new guardrail config

Creates a new guardrail configuration with the provided description, pass criteria, and fail criteria.

Path Parameters

api-version-string

required, string, default: latest

Request Body

name

optional, string, default: Guardrail

Name

active

optional, boolean, default: true

Active

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

examples

optional, string

name

optional, string, default: Guardrail

Name

active

optional, boolean, default: true

Active

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

examples

optional, string

name

optional, string, default: Guardrail

Name

active

optional, boolean, default: true

Active

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

examples

optional, string

name

optional, string, default: Guardrail

Name

active

optional, boolean, default: true

Active

description

optional, string, default: Guardrail description

Description

pass-criteria

optional, string, default: Guardrail pass criteria

Pass criteria

fail-criteria

optional, string, default: Guardrail fail criteria

Fail criteria

examples

optional, string
POST
/api/:api-version-string/configs/guardrails
1
EXAMPLE BODY
{
  "name": "Guardrail",
  "active": true,
  "examples": "est aliquip occaecat adipisicing"
}

Check prompt against the guardrails checks.

Checks guardrails for a given user and story.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Story ID

user-query

optional, string, default: User query

User query

story-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Story ID

user-query

optional, string, default: User query

User query

story-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Story ID

user-query

optional, string, default: User query

User query

story-id

optional, string, default: 00000000-0000-0000-0000-000000000000

Story ID

user-query

optional, string, default: User query

User query

POST
/api/:api-version-string/configs/guardrails/check/prompt
1
EXAMPLE BODY
{
  "story-id": "00000000-0000-0000-0000-000000000000"
}

Get a specific guardrail config

Retrieves a guardrail configuration using the provided ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
GET
/api/:api-version-string/configs/guardrails/:id
1

Delete a specific guardrail config

Deletes a guardrail configuration using the provided ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
DELETE
/api/:api-version-string/configs/guardrails/:id
1

Generate embeddings for json

Generates embeddings for a JSON file. Provide the JSON file under the key data and the file name under the key filename. The response will include the ID of the embedding.

Path Parameters

api-version-string

required, string, default: latest

Request Body

filename

required, string

data

required, object

s3-url

required, string

filename

required, string

data

required, object

s3-url

required, string

filename

required, string

data

required, object

s3-url

required, string

filename

required, string

data

required, object

s3-url

required, string
POST
/api/:api-version-string/embeddings/vector
1
EXAMPLE BODY
{
  "filename": "cillum exercitation aliqua ut",
  "data": {},
  "s3-url": "nulla incididunt id dolore est"
}

Update user data in the database.

Updates the authenticated user's data in the database.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string
username
optional
first-name
optional
last-name
optional

email

optional, string, minimum length of 4
type
optional
is-active
optional

image

optional, string, minimum length of 4

email-verified

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-disclaimer-banner

optional, boolean
hide-home-page-onboarding
optional
hide-story-page-onboarding
optional
hide-photomaker-modal
optional
last-feedback-timestamp
optional
use-case
optional
use-case-details
optional

topics-of-interest

optional, array
onboarding-flow-completed
optional
has-selected-membership
optional

id

required, string
username
optional
first-name
optional
last-name
optional

email

optional, string, minimum length of 4
type
optional
is-active
optional

image

optional, string, minimum length of 4

email-verified

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-disclaimer-banner

optional, boolean
hide-home-page-onboarding
optional
hide-story-page-onboarding
optional
hide-photomaker-modal
optional
last-feedback-timestamp
optional
use-case
optional
use-case-details
optional

topics-of-interest

optional, array
onboarding-flow-completed
optional
has-selected-membership
optional

id

required, string
username
optional
first-name
optional
last-name
optional

email

optional, string, minimum length of 4
type
optional
is-active
optional

image

optional, string, minimum length of 4

email-verified

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-disclaimer-banner

optional, boolean
hide-home-page-onboarding
optional
hide-story-page-onboarding
optional
hide-photomaker-modal
optional
last-feedback-timestamp
optional
use-case
optional
use-case-details
optional

topics-of-interest

optional, array
onboarding-flow-completed
optional
has-selected-membership
optional

id

required, string
username
optional
first-name
optional
last-name
optional

email

optional, string, minimum length of 4
type
optional
is-active
optional

image

optional, string, minimum length of 4

email-verified

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-disclaimer-banner

optional, boolean
hide-home-page-onboarding
optional
hide-story-page-onboarding
optional
hide-photomaker-modal
optional
last-feedback-timestamp
optional
use-case
optional
use-case-details
optional

topics-of-interest

optional, array
onboarding-flow-completed
optional
has-selected-membership
optional
PUT
/api/:api-version-string/user
1
EXAMPLE BODY
{
  "id": "186a746e-f240-4040-3dbb-2776f038db9c",
  "username": null,
  "is-active": false,
  "hide-story-page-onboarding": true,
  "has-selected-membership": null
}

Search users

Searches for users based on a query string.

Query Parameters

query

optional, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/users
1

Get user by ID

Retrieves a user's information by their unique ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
GET
/api/:api-version-string/user/users/:id
1

Delete user by ID

Deletes a user's profile by their unique ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
DELETE
/api/:api-version-string/user/users/:id
1

Check username availability

Checks if a username can be saved in the database.

Query Parameters

username

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/username
1

Upload a profile photo

Allows the user to upload a profile photo.

Path Parameters

api-version-string

required, string, default: latest

Request Body

Unnamed Property

Unnamed Property

Unnamed Property

Unnamed Property

POST
/api/:api-version-string/user/avatar
1
EXAMPLE BODY
{}

Save user settings

Saves the user's settings.

Path Parameters

api-version-string

required, string, default: latest

Request Body

default-publicity

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-home-page-onboarding

optional, boolean

hide-disclaimer-banner

optional, boolean

hide-photomaker-modal

optional, boolean

onboarding-flow-completed

optional, boolean

hide-story-page-onboarding

optional, boolean

has-selected-membership

optional, boolean

mailing-list

optional, boolean

default-publicity

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-home-page-onboarding

optional, boolean

hide-disclaimer-banner

optional, boolean

hide-photomaker-modal

optional, boolean

onboarding-flow-completed

optional, boolean

hide-story-page-onboarding

optional, boolean

has-selected-membership

optional, boolean

mailing-list

optional, boolean

default-publicity

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-home-page-onboarding

optional, boolean

hide-disclaimer-banner

optional, boolean

hide-photomaker-modal

optional, boolean

onboarding-flow-completed

optional, boolean

hide-story-page-onboarding

optional, boolean

has-selected-membership

optional, boolean

mailing-list

optional, boolean

default-publicity

optional, boolean

hide-first-time-signin-modal

optional, boolean

hide-home-page-onboarding

optional, boolean

hide-disclaimer-banner

optional, boolean

hide-photomaker-modal

optional, boolean

onboarding-flow-completed

optional, boolean

hide-story-page-onboarding

optional, boolean

has-selected-membership

optional, boolean

mailing-list

optional, boolean
POST
/api/:api-version-string/user/settings
1
EXAMPLE BODY
{
  "default-publicity": false
}

Sign out

Signs out the current user.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/sign-out
1

Retrieve current user's QR code

Fetches the QR code for the authenticated user.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/qr-code
1

Retrieve current org

Retrieves the details of the currently authenticated user.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/current-org
1

Stripe Webhook for Membership Updates

Handles webhook notifications from Stripe, triggered when a user completes a plan purchase or an event occurs within Stripe. Processes updates to user memberships accordingly.

Path Parameters

api-version-string

required, string, default: latest
POST
/api/:api-version-string/user/membership/stripe-webhook
1

Retrieve Current User Membership

Fetches the user's current membership details, including whether they have a free plan or a paid pro plan.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/membership/current-membership
1

Retrieve All User Memberships

Provides a list of all memberships associated with the user, including current and any historical memberships.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/membership/all
1

Get Available Membership Plans

Returns the list of membership plans currently available for purchase, as configured within Stripe.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/membership/products
1

Handle Successful Plan Purchase

Called by Stripe upon successful plan purchase, finalizing the membership update for the user in the system.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/membership/success
1

Create a New Stripe Session

Generates a new session to initiate the plan purchase process via Stripe.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/membership/session
1

Submit user feedback and receive credits

Saves user feedback and grants credits to the user's account in exchange. This feedback can help improve the story or system performance.

Path Parameters

api-version-string

required, string, default: latest

Request Body

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

feedback

required, object, default: {}

User feedback

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

feedback

required, object, default: {}

User feedback

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

feedback

required, object, default: {}

User feedback

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

feedback

required, object, default: {}

User feedback

POST
/api/:api-version-string/user/feedback
1
EXAMPLE BODY
{
  "user-id": "00000000-0000-0000-0000-000000000000",
  "feedback": {}
}

Verify if the story has been rated by its author

Checks whether the author has already rated their story with a thumbs up or thumbs down.

Query Parameters

story-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/feedback/thumbs
1

Record thumbs up/down feedback for a story

Saves a thumbs up or down rating for a story, indicating whether the author liked or disliked it.

Path Parameters

api-version-string

required, string, default: latest

Request Body

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

liked

required, boolean, default: false

User liked the story

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

liked

required, boolean, default: false

User liked the story

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

liked

required, boolean, default: false

User liked the story

story-id

required, string, default: 00000000-0000-0000-0000-000000000000

Story ID

liked

required, boolean, default: false

User liked the story

POST
/api/:api-version-string/user/feedback/thumbs
1
EXAMPLE BODY
{
  "story-id": "00000000-0000-0000-0000-000000000000",
  "liked": false
}

Retrieve all story configurations for the user

Fetches a list of all story configurations saved by the user. These configurations determine settings such as length and style for story creation.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/storyplan-config
1

Update an existing story configuration

Updates an existing user story configuration by ID, with options to modify the configuration name, display name, and storyplan details.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object
PUT
/api/:api-version-string/user/storyplan-config
1
EXAMPLE BODY
{
  "id": "e6f39fbc-cff6-929b-638f-8c7df66c9600",
  "config-name": "fugiat dolore et pariatur nostrud",
  "config-display-name": "commodo nostrud",
  "storyplan": {}
}

Delete a user story configuration

Removes a story configuration from the user's account, identified by configuration ID.

Query Parameters

id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/user/storyplan-config
1

Create a new story configuration

Generates a new story configuration with optional fields such as description, configuration name, and display name. The storyplan structure allows custom settings for the story.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

description

optional, string

config-name

optional, string

config-display-name

required, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

required, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

required, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

required, string

storyplan

optional, object
POST
/api/:api-version-string/user/storyplan-config
1
EXAMPLE BODY
{
  "id": "8174e82a-bef8-7e1e-f5ea-1963b0081f52",
  "description": "fugiat",
  "config-name": "laborum cillum in qui",
  "config-display-name": "in dolor irure commodo laboris",
  "storyplan": {}
}

Fetch available story plan schemas

Retrieves the list of available story plan schemas that define customizable options, such as length, tone, and audience, for story creation.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/storyplan-config/schemas
1

Generate title and description with AI

Uses an AI model to generate a suggested title and description based on provided settings, including audience, creativity level, and reading level.

Path Parameters

api-version-string

required, string, default: latest

Request Body

audience

optional, string

creativity

optional, string

custom-instructions

optional, string

length

optional, string

output-language

optional, string

personality

optional, string

reading-level

optional, string

report-type

optional, string

title-style

optional, string

audience

optional, string

creativity

optional, string

custom-instructions

optional, string

length

optional, string

output-language

optional, string

personality

optional, string

reading-level

optional, string

report-type

optional, string

title-style

optional, string

audience

optional, string

creativity

optional, string

custom-instructions

optional, string

length

optional, string

output-language

optional, string

personality

optional, string

reading-level

optional, string

report-type

optional, string

title-style

optional, string

audience

optional, string

creativity

optional, string

custom-instructions

optional, string

length

optional, string

output-language

optional, string

personality

optional, string

reading-level

optional, string

report-type

optional, string

title-style

optional, string
POST
/api/:api-version-string/user/storyplan-config/gen-mode-data
1
EXAMPLE BODY
{
  "audience": "occaecat dolor et elit Ut",
  "creativity": "elit aliquip",
  "custom-instructions": "ex Lorem ea",
  "length": "in",
  "output-language": "ad enim magna",
  "personality": "Lorem culpa eu",
  "reading-level": "esse aliqua ea",
  "report-type": "Lorem"
}

Retrieve user's default story configurations

Fetches the default story configuration set by the user for streamlined story creation.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/user/storyplan-config/default
1

Set a default story configuration for the user

Allows the user to set a specific story configuration as the default for future story creation.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

id

required, string

id

required, string

id

required, string
POST
/api/:api-version-string/user/storyplan-config/default
1
EXAMPLE BODY
{
  "id": "fab6466c-7924-aabf-f1ef-7b1186e408b3"
}

Create or update a story configuration by name

Creates a new story configuration or updates an existing one, using the provided configuration name to identify it.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

description

optional, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object

id

required, string

description

optional, string

config-name

optional, string

config-display-name

optional, string

storyplan

optional, object
POST
/api/:api-version-string/user/storyplan-config/upsert-by-name
1
EXAMPLE BODY
{
  "id": "161cc837-8212-1a73-4458-9624db1cf2b7",
  "config-name": "laboris ea ex",
  "storyplan": {}
}

home

GET
/
1

/info

GET
/info
1

Report the latest API version

Path Parameters

api-version-string

required
GET
/api-version
1

Search for stories and users that match a specific value. Stories are searched on headline + lead-in. Sort-by, limit, and descending are all optional (default: limit 30, most recent first).

Query Parameters

search-value

required

limit

optional

sort-by

optional

descending

optional

Path Parameters

api-version-string

required
GET
/stories/search
1

Retrieve generated prompts for the homepage

Fetches a curated list of prompts generated by our LLM to display on the homepage. These prompts provide users with suggestions and ideas to help them get started.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/prompts
1

Get all API example prompts

Fetches a list of all API example prompts.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/api_example_prompts
1

Create a new API example prompt

Creates a new example prompt for API use.

Path Parameters

api-version-string

required, string, default: latest

Request Body

prompt

required, string

prompt

required, string

prompt

required, string

prompt

required, string
POST
/api/:api-version-string/api_example_prompts
1
EXAMPLE BODY
{
  "prompt": "labore est ullamco enim dolore"
}

Delete an API example prompt by ID

Deletes a specific API example prompt by ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
DELETE
/api/:api-version-string/api_example_prompts/:id
1

regenerate prompts

regenerate prompts

Path Parameters

api-version-string

required, string, default: latest
POST
/api/:api-version-string/api_prompts/org/regenerate
1

Get all API prompts

Fetches a list of all API prompts.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/api_prompts
1

Create a new API prompt

Creates a new API prompt.

Path Parameters

api-version-string

required, string, default: latest

Request Body

prompt

required, string

longPrompt

optional, string

prompt

required, string

longPrompt

optional, string

prompt

required, string

longPrompt

optional, string

prompt

required, string

longPrompt

optional, string
POST
/api/:api-version-string/api_prompts
1
EXAMPLE BODY
{
  "prompt": "est velit"
}

Delete an API prompt by ID

Deletes a specific API prompt by ID.

Path Parameters

api-version-string

required, string, default: latest

id

required, string
DELETE
/api/:api-version-string/api_prompts/:id
1

Initiate Twitter OAuth authentication

Generates the OAuth URI to begin the authentication process with Twitter, allowing users to authorize the app.

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/x/v1/oauth
1

Handle Twitter OAuth callback

Processes the callback from Twitter OAuth after the user has authorized the app. Requires the OAuth token and verifier to complete the authentication.

Path Parameters

api-version-string

required, string, default: latest

Request Body

oauth-token

required, string

oauth-verifier

required, string

oauth-token

required, string

oauth-verifier

required, string

oauth-token

required, string

oauth-verifier

required, string

oauth-token

required, string

oauth-verifier

required, string
POST
/api/:api-version-string/x/v1/callback
1
EXAMPLE BODY
{
  "oauth-token": "consequat eu occaecat qui",
  "oauth-verifier": "incididunt"
}

Post a tweet with media

Publishes a tweet containing media, such as images. Requires tweet text and media content for successful posting.

Path Parameters

api-version-string

required, string, default: latest

Request Body

text

required, string

media

required

text

required, string

media

required

text

required, string

media

required

text

required, string

media

required
POST
/api/:api-version-string/x/media
1
EXAMPLE BODY
{
  "text": "voluptate est nostrud reprehenderit",
  "media": {}
}

Retrieve all visible notifications for a user

Fetches all notifications for a user that are not marked as hidden, identified by the user-id. Notifications include updates, interactions, and other relevant alerts.

Query Parameters

user-id

required, string

Path Parameters

api-version-string

required, string, default: latest
GET
/api/:api-version-string/notification
1

Soft delete a notification

Marks a notification as hidden, making it invisible to the user without permanently deleting it from the database. Identified by notification ID.

Query Parameters

id

required, string

Path Parameters

api-version-string

required, string, default: latest
DELETE
/api/:api-version-string/notification
1

Create a new notification

Creates a new notification for a user, associating it with an optional story ID or liker user ID. Allows specifying timestamps and custom messages.

Path Parameters

api-version-string

required, string, default: latest

Request Body

id

required, string

user-id

required, string

story-id

required, string

message

required, string
liker-user-id
optional

created-at

optional, string

updated-at

optional, string

id

required, string

user-id

required, string

story-id

required, string

message

required, string
liker-user-id
optional

created-at

optional, string

updated-at

optional, string

id

required, string

user-id

required, string

story-id

required, string

message

required, string
liker-user-id
optional

created-at

optional, string

updated-at

optional, string

id

required, string

user-id

required, string

story-id

required, string

message

required, string
liker-user-id
optional

created-at

optional, string

updated-at

optional, string
POST
/api/:api-version-string/notification
1
EXAMPLE BODY
{
  "id": "fc2e4bfd-2236-c970-19a6-9e1ad9d77dfc",
  "user-id": "0c118aed-2385-33a1-5468-31ff7dc04070",
  "story-id": "2a7d16f1-f291-7e7c-7171-6058c018328d",
  "message": "dolore quis",
  "liker-user-id": null,
  "created-at": "1904-02-15T02:50:43.0Z",
  "updated-at": "1917-02-16T01:43:42.0Z"
}

Apply credits to a user's account with a promo code

Adds credits to the specified user account by validating and applying a promo code.

Path Parameters

api-version-string

required, string, default: latest

Request Body

promo-code

required, string, default: PROMO123

Promo code

promo-code

required, string, default: PROMO123

Promo code

promo-code

required, string, default: PROMO123

Promo code

promo-code

required, string, default: PROMO123

Promo code

POST
/api/:api-version-string/user/boost
1
EXAMPLE BODY
{
  "promo-code": "PROMO123"
}

Directly add credits to a user's account

Manually credits the user's account based on provided user ID and credit amount. Additional notes can be included for record-keeping.

Path Parameters

api-version-string

required, string, default: latest

Request Body

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

credits

required, integer, default: 100

Credits

notes

required, string, default: Credits added for testing

Notes

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

credits

required, integer, default: 100

Credits

notes

required, string, default: Credits added for testing

Notes

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

credits

required, integer, default: 100

Credits

notes

required, string, default: Credits added for testing

Notes

user-id

required, string, default: 00000000-0000-0000-0000-000000000000

User ID

credits

required, integer, default: 100

Credits

notes

required, string, default: Credits added for testing

Notes

POST
/api/:api-version-string/user/credits
1
EXAMPLE BODY
{
  "user-id": "00000000-0000-0000-0000-000000000000",
  "credits": 100,
  "notes": "Credits added for testing"
}