Prompts
Create, update, list, delete, and audit prompts over HTTP.
Prompts capture versioned generative instructions for video and related modalities. The HTTP API aligns with the Prompt resource in the TypeScript SDK.
Base path: /api/v1/prompts. Include authentication headers.
List and create
List prompts
GET /api/v1/prompts
Returns JSON for prompts in the scoped project.
Create prompt
POST /api/v1/prompts
- Body: JSON with fields such as name, content, type (for example
text-to-video), plus optional metadata supported by your workspace. - Returns: JSON including the prompt id and identifiers used in dashboards.
Single prompt by id
Replace {id} with the prompt id.
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/prompts/{id} | Fetch the latest prompt document. |
| PUT | /api/v1/prompts/{id} | Update mutable fields (for example content or labels). |
| DELETE | /api/v1/prompts/{id} | Remove the prompt from default listings (soft delete semantics in the product). |
Prompt activity
GET /api/v1/prompts/{id}/activity
Returns JSON describing recent edits and events for auditing.
Optional query parameter:
| Parameter | Type | Purpose |
|---|---|---|
limit | number | Cap the number of activity rows returned. |
Lookup by identifier
GET /api/v1/prompts/by-identifier/{identifier}
- Path:
identifieris the stable human-chosen identifier for the prompt within the project. - Returns: JSON prompt document when found; 404 JSON error when no prompt matches.
Use this route in serving paths where you prefer a slug instead of an opaque id.
Related
- Prompts overview for product concepts and editing workflows.