Skip to main content
GET
/
content
List content
curl --request GET \
  --url https://server.promptwatch.com/api/v2/content \
  --header 'X-API-Key: <api-key>'
{
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "PENDING",
      "mode": "CREATE",
      "type": "ARTICLE",
      "title": "<string>",
      "promptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "totalPages": 1
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

​
page
integer
default:1

Page number (1-based).

Required range: x >= 1
​
size
integer
default:25

Page size (max 100); matches other v2 list endpoints.

Required range: 1 <= x <= 100
​
orderBy
enum<string>
default:createdAt

Sort field.

Available options:
createdAt,
updatedAt
​
sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
mode
enum<string>

Filter by CREATE vs OPTIMIZE.

Available options:
CREATE,
OPTIMIZE
​
status
enum<string>

Filter by generation status.

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED,
STOPPED

Response

Default Response

​
documents
object[]
required

Documents for the current page (no full markdown body).

​
total
integer
required

Total documents matching filters (all pages).

Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required

Page length (same as request size).

Required range: x >= 1
​
totalPages
integer
required

Ceil(total / size).

Required range: x >= 0