---

aside: false outline: false

v0.1.0

Slop Poe API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Auth, app management, and app hosting APIs for Slop Poe.

---

Auth

Operations

POST/auth/loginGET/auth/sessionPOST/auth/logoutGET/auth/usageGET/auth/points-historyGET/auth/modelsGET/auth/connected-accountsDELETE/auth/connected-accounts/{providerId}

---

Login with Poe API key

POST

/auth/login

Request Body

application/json

{

"api_key": "string"

}

Responses

Login result

Content-Type

application/json

{

"success": true,

"user": {

"user_id": "string",

"username": "string",

"display_name": "string",

"profile_picture": "string"

}

}

POST

/auth/login

Playground

Body

Samples

---

Get current session

GET

/auth/session

Responses

Session result

Content-Type

application/json

{

"success": true,

"user": {

"user_id": "string",

"username": "string",

"display_name": "string",

"profile_picture": "string"

}

}

GET

/auth/session

Playground

Samples

---

Logout and clear session

POST

/auth/logout

Responses

Logout success

Content-Type

application/json

{

"success": true

}

POST

/auth/logout

Playground

Samples

---

Get current points balance

GET

/auth/usage

Authorizations

Responses

Usage result

Content-Type

application/json

{

"success": true,

"pointBalance": 0

}

GET

/auth/usage

Playground

Samples

---

Get usage history

GET

/auth/points-history

Authorizations

Responses

Points history result

Content-Type

application/json

{

"success": true,

"history": [

{

"bot_name": "string",

"creation_time": 0,

"query_id": "string",

"cost_points": 0,

"usage_type": "string",

"additionalProperties": "string"

}

]

}

GET

/auth/points-history

Playground

Samples

---

List available models

GET

/auth/models

Authorizations

Responses

Models list result

Content-Type

application/json

{

"success": true,

"models": [

{

"id": "string",

"description": "string",

"owned_by": "string",

"metadata": {

"display_name": "string",

"additionalProperties": "string"

},

"additionalProperties": "string"

}

]

}

GET

/auth/models

Playground

Samples

---

List connected external accounts

GET

/auth/connected-accounts

Authorizations

Responses

Connected accounts result

Content-Type

application/json

{

"success": true,

"accounts": [

{

"provider_id": "string",

"external_username": "string",

"external_display_name": "string"

}

]

}

GET

/auth/connected-accounts

Playground

Samples

---

Unlink an external account

DELETE

/auth/connected-accounts/{providerId}

Authorizations

Parameters

Path Parameters

providerId*

Type

string

Required

Min Length

1

Responses

Unlink result

Content-Type

application/json

{

"success": true

}

DELETE

/auth/connected-accounts/{providerId}

Playground

Variables

Key

Value

providerId*

Samples

---

Apps

Operations

GET/appsPOST/appsGET/apps/{appHandleOrId}POST/apps/publish

---

List all published apps

GET

/apps

Responses

Apps list result

Content-Type

application/json

{

"success": true,

"apps": [

{

"id": "string",

"handle": "string",

"creator_id": "string",

"creator_handle": "string",

"created_at": "string",

"updated_at": "string"

}

]

}

GET

/apps

Playground

Samples

---

Create a new app

POST

/apps

Authorizations

Request Body

application/json

{

"handle": "string",

"html": "string"

}

Responses

App create result

Content-Type

application/json

{

"success": true,

"app": {

"id": "string",

"handle": "string",

"creator_id": "string",

"creator_handle": "string",

"created_at": "string",

"updated_at": "string"

}

}

POST

/apps

Playground

Body

Samples

---

Get app details with bundle URL

GET

/apps/{appHandleOrId}

Parameters

Path Parameters

appHandleOrId*

Type

string

Required

Min Length

1

Responses

App details result

Content-Type

application/json

{

"success": true,

"app": {

"id": "string",

"handle": "string",

"creator_id": "string",

"creator_handle": "string",

"created_at": "string",

"updated_at": "string",

"bundleUrl": "string"

}

}

GET

/apps/{appHandleOrId}

Playground

Variables

Key

Value

appHandleOrId*

Samples

---

Publish an app with Bearer API key

POST

/apps/publish

Authorizations

Responses

Publish result

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/apps/publish

Playground

Samples

---

App Bundles

Operations

POST/app-bundles/upload

---

Upload a zip bundle for app hosting

POST

/app-bundles/upload

Authorizations

Responses

Upload result

Content-Type

application/json

{

"additionalProperties": "string"

}

POST

/app-bundles/upload

Playground

Samples

---

Permissions

Operations

GET/permissionsGET/permissions/checkGET/permissions/scopesPOST/permissions/grantDELETE/permissions/{appId}/{scope}

---

List all granted scopes for user+app

GET

/permissions

Authorizations

Parameters

Query Parameters

appId*

Type

string

Required

Min Length

1

Responses

Permissions list result

Content-Type

application/json

{

"success": true,

"scopes": [

"string"

]

}

GET

/permissions

Playground

Variables

Key

Value

appId*

Samples

---

Check whether a specific scope is granted

GET

/permissions/check

Authorizations

Parameters

Query Parameters

appId*

Type

string

Required

Min Length

1

scope*

Type

string

Required

Min Length

1

Responses

Permission check result

Content-Type

application/json

{

"success": true,

"granted": true

}

GET

/permissions/check

Playground

Variables

Key

Value

appId*

scope*

Samples

---

List all available platform scopes

GET

/permissions/scopes

Responses

Available scopes list

Content-Type

application/json

{

"success": true,

"scopes": [

{

"scope": "string",

"displayName": "string",

"description": "string",

"requiresOAuth": true,

"oauthProviderId": "string"

}

]

}

GET

/permissions/scopes

Playground

Samples

---

Grant scopes to user+app

POST

/permissions/grant

Authorizations

Request Body

application/json

{

"appId": "string",

"scopes": [

"string"

]

}

Responses

Grant result

Content-Type

application/json

{

"success": true

}

POST

/permissions/grant

Playground

Body

Samples

---

Revoke a specific permission scope

DELETE

/permissions/{appId}/{scope}

Authorizations

Parameters

Path Parameters

appId*

Type

string

Required

Min Length

1

scope*

Type

string

Required

Min Length

1

Responses

Revoke result

Content-Type

application/json

{

"success": true

}

DELETE

/permissions/{appId}/{scope}

Playground

Variables

Key

Value

appId*

scope*

Samples

---

Powered by VitePress OpenAPI