Skip to content

Guides API reference

App Home Pricing

Theme

Endless API reference

REST API for the Endless platform. Every endpoint requires JWT authentication via a Bearer token. These pages are generated from the OpenAPI spec, served at https://api.endless.app/openapi.json. How versions are pinned and operations retired: Endless API versioning and deprecation policy.

Access

Create access grant POST
Delete access grant DELETE
Get access GET
Update access general access PATCH
Update access grant PATCH

Activity

List activity GET

Alert policy

Get alert policy GET
Update alert policy PATCH

Assets

Create asset POST
Delete asset DELETE
Extract prompt from asset POST
Get asset GET
Import asset from link POST
List models used by assets GET
List asset voices GET
List assets GET
Restore asset POST
Update asset PATCH

Billing

Cancel scheduled plan change DELETE
Change subscription plan PATCH
Create billing customer POST
Create billing portal session POST
List billing events GET
Get billing info GET
Preview plan change GET
Get subscription status GET
Update billing customer PATCH

Canvases

Create canvas POST
Delete canvas DELETE
Get canvas access GET
Get canvas GET
List canvases GET
Update canvas PATCH

Chat models

List available chat models GET
Copy chat model list GET
Copy chat model upsert PUT
Get chat model GET
List chat models GET

Connector credentials

Delete connector credential DELETE
List connector credentials GET
Set connector credential PATCH

Connectors

Create connector POST
Delete connector DELETE
Update connector PATCH

Conversations

Create conversation POST
Delete conversation DELETE
Fork conversation POST
Get conversation access GET
Get conversation GET
List conversations GET
Append conversation message POST
List conversation messages GET
Recall conversations GET
Restore conversation POST
Acquire conversation run lock POST
Release conversation run lock DELETE
Snapshot conversation run POST
Update conversation PATCH

Credits

Get credit balance GET
Begin credits chat run POST
Capture credits chat run POST
Settle credits chat run POST
Get credit cycle GET
List credit transactions GET

Custom skills

Create custom skill POST
Delete custom skill DELETE
Get custom skill GET
Update custom skill PATCH

Documents

Get document access GET

Generations

Create generation POST
Get generation GET
List generations GET
Quote generation POST
Update generation PATCH

Invitations

Create invitation POST
Decline invitation POST
Delete invitation DELETE
List invitations GET
Update invitation PATCH

Library

List library GET

Members

Get member credits GET
Delete member DELETE
Get member GET
Leave organization POST
List members GET
Update member PATCH

Models

Public model list GET

Organization logo

Remove organization logo DELETE
Update organization logo PUT

Organizations

Check slug availability GET
Create organization POST
Delete organization DELETE
Get organization GET
Mark organization as onboarded POST
Update organization PATCH

Projects

List project accounts GET
Archive project POST
Add project asset POST
List project assets GET
Remove project asset DELETE
Add project canvas POST
List project canvases GET
Remove project canvas DELETE
Add project conversation POST
List project conversations GET
Remove project conversation DELETE
Create project POST
Delete project DELETE
List projects for asset GET
List projects for canvas GET
List projects for conversation GET
List projects for skill GET
Get project GET
List projects GET
Restore project POST
Add project skill POST
List project skills GET
Remove project skill DELETE
Unarchive project POST
Update project PATCH

Reports

Get credit balance and runway GET
Get workspace inventory POST
Query a usage report POST

Roles

List roles GET
Reset role permissions DELETE
Set role permissions PATCH

Scheduled tasks

Cancel scheduled task run POST
Complete scheduled task run POST
Create scheduled task POST
Delete scheduled task DELETE
Get scheduled task GET
List scheduled tasks GET
List all scheduled task runs GET
List scheduled task run email recipients GET
Trigger scheduled task POST
Update scheduled task PATCH

Search

List the search operations GET
Read web pages POST
Search the web POST

Social

Teams

Create team POST
Get team credits GET
Delete team DELETE
Get team GET
List teams GET
Add team member POST
List team members GET
Remove team member DELETE
Update team PATCH

Tools

List tools GET
Resolve tools POST
Set tool state PATCH

Transcripts

Create transcript POST
Get transcript GET
Reserve transcript audio upload POST
Switch transcript language POST
Update transcript PATCH

Users

Read a brand's sources POST
Delete user DELETE
Get user GET
Remove user image DELETE
Update user image PUT
List user memberships GET
Find a social account's picture GET
Look up a social account GET
List user teams GET
Update user PATCH

Voices

Delete voice DELETE
List voices GET
Train voice POST
Update voice PATCH

Workspace chat models

Get workspace chat model governance GET
List workspace chat models GET
Set workspace chat model positions PUT
Set workspace chat model state PATCH

Workspace models

Get workspace model governance GET
List workspace models GET
Set workspace model positions PUT
Set workspace model state PATCH
Get workspace model version GET