Platform API Reference (v1)
Overview
The Unstract Platform API provides programmatic access to all platform resources. All tenant-scoped endpoints share a common base URL and authentication scheme.
Base URL: {host}/api/v1/unstract/{org_id}
Authentication: Authorization: Bearer <platform-api-key>
Permission Model
Platform API keys carry a permission level that restricts which HTTP methods are allowed:
| Permission | Allowed Methods |
|---|---|
read | GET, HEAD, OPTIONS |
read_write | All methods except DELETE |
DELETE operations are blocked for all platform API keys (enforced at middleware). Service accounts created for API keys can read/write all resources within the organization.
API Sections
| Section | Description |
|---|---|
| Platform API Keys | Manage API keys (admin only, session auth) |
| Prompt Studio | Manage Prompt Studio projects, prompts, profiles, and documents |
| Workflows | Create and manage workflows, executions, and file history |
| API Deployments | Deploy workflows as APIs, manage deployment keys, execute |
| ETL Pipelines | Create and manage ETL/Task pipelines |
| Adapters | Manage LLM, embedding, vector DB, and text extractor adapters |
| Connectors | Manage filesystem and database connectors |
| Cascading Workflows | Promote projects and deployments across environments |
Authentication Examples
curl
curl -H "Authorization: Bearer <platform-api-key>" \
https://your-domain.com/api/v1/unstract/{org_id}/prompt-studio/
Python
import requests
headers = {"Authorization": "Bearer <platform-api-key>"}
resp = requests.get(
"https://your-domain.com/api/v1/unstract/{org_id}/prompt-studio/",
headers=headers,
)
print(resp.json())