Skip to content
Get started

API Reference

Libraries

npm install 0ct

API Overview

Promptly

List all runs
GET/api/promptly/runs
Get usage statistics
GET/api/promptly/stats

PromptlyTasks

List all tasks
GET/api/promptly/tasks
Create a new task
POST/api/promptly/tasks
Get a task
GET/api/promptly/tasks/{taskId}
Update a task
PATCH/api/promptly/tasks/{taskId}
Delete a task
DELETE/api/promptly/tasks/{taskId}
Run a task immediately
POST/api/promptly/tasks/{taskId}/run
List task runs
GET/api/promptly/tasks/{taskId}/runs

PromptlyTasksSources

Attach a source to a task
POST/api/promptly/tasks/{taskId}/sources
Detach a source from a task
DELETE/api/promptly/tasks/{taskId}/sources/{sourceId}

PromptlyTasksSkills

Attach a skill to a task
POST/api/promptly/tasks/{taskId}/skills
Detach a skill from a task
DELETE/api/promptly/tasks/{taskId}/skills/{skillId}

PromptlySources

List all sources
GET/api/promptly/sources
Create a source
POST/api/promptly/sources
Get a source
GET/api/promptly/sources/{sourceId}
Update a source
PATCH/api/promptly/sources/{sourceId}
Delete a source
DELETE/api/promptly/sources/{sourceId}
Test a source connection
POST/api/promptly/sources/{sourceId}/test

PromptlySkills

List all skills
GET/api/promptly/skills
Create a skill
POST/api/promptly/skills
Get a skill
GET/api/promptly/skills/{skillId}
Update a skill
PATCH/api/promptly/skills/{skillId}
Delete a skill
DELETE/api/promptly/skills/{skillId}

PromptlyModels

List available models
GET/api/promptly/models
Get a model
GET/api/promptly/models/{modelId}

PromptlyBilling

Get billing status
GET/api/promptly/billing/status
Create checkout session
POST/api/promptly/billing/checkout
Create billing portal session
POST/api/promptly/billing/portal