Prompteus
Sign inSign up

API Reference

Build powerful integrations with the Prompteus REST API

Get API KeyView SDKs

Quick Start

Get started with the Prompteus API in minutes

1. Get your API key

Generate an API key from your dashboard settings

2. Make your first request

curl -X GET https://api.prompteus.com/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Handle the response

{
  "data": [
    {
      "id": "prod_123abc",
      "title": "Advanced GPT-4 Prompt",
      "price": 9.99,
      "type": "PROMPT"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42
  }
}

Authentication

Secure your API requests with Bearer token authentication

API Key Authentication

Include your API key in the Authorization header of each request:

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

For advanced integrations, we support OAuth 2.0 with the following grant types:

  • Authorization Code
  • Client Credentials
  • Refresh Token

Rate Limiting

API rate limits based on your subscription plan

100
Free Plan
requests/hour
1,000
Pro Plan
requests/hour
10,000
Enterprise
requests/hour

Rate Limit Headers

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

API Endpoints

Authentication

POST
/api/auth/login
Login with email/password
POST
/api/auth/register
Create new account
POST
/api/auth/refresh
Refresh access token
POST
/api/auth/logout
Logout and invalidate token

Products

GET
/api/products
List all products
GET
/api/products/:id
Get product details
POST
/api/products
Create new product
PUT
/api/products/:id
Update product
DELETE
/api/products/:id
Delete product

Orders

GET
/api/orders
List user orders
POST
/api/orders
Create new order
GET
/api/orders/:id
Get order details
POST
/api/orders/:id/refund
Request refund

Workflows

POST
/api/workflows/:id/execute
Execute workflow
GET
/api/workflows/:id/executions
List executions
GET
/api/workflows/executions/:id
Get execution details

Response Format

All API responses follow a consistent JSON structure

Success Response

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_abc123"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is invalid",
    "details": {
      "field": "price",
      "reason": "Must be a positive number"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_abc123"
  }
}

Official SDKs

Use our official libraries for easier integration

JavaScript/TypeScript

Stable
npm install @prompteus/sdk
View on GitHub

Python

Stable
pip install prompteus
View on GitHub

Go

Beta
go get github.com/prompteus/sdk-go
View on GitHub

Ruby

Coming Soon
gem install prompteus

OpenAPI Spec

Download our OpenAPI specification for code generation

Download Spec

Postman Collection

Import our collection to test APIs quickly

View Collection

API Status

Check current API status and incidents

View Status