Prompt Studio

Prompt Studio endpoints manage projects (called "Custom Tools" internally), prompts, LLM profiles, documents, and tool exports.

Authentication

These endpoints require a Bearer token or session auth. Permission varies by action — most endpoints use IsOwnerOrSharedUserOrSharedToOrg, while delete operations require IsOwner.

---

Projects (Custom Tools)

Create, list, retrieve, update, and delete Prompt Studio projects.

GET/api/v1/unstract/{org_id}/prompt-studio/

List all Prompt Studio projects accessible to the current user.▾

POST/api/v1/unstract/{org_id}/prompt-studio/

Create a new Prompt Studio project.▾

GET/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/

Retrieve a single Prompt Studio project by its ID.▾

PUT/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/

Fully update a Prompt Studio project. All writable fields should be provided.▾

PATCH/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/

Partially update a Prompt Studio project. Only provided fields are updated.▾

DELETE/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/

Delete a Prompt Studio project. Returns 204 No Content on success. Fails with 409 Conflict if the tool has been exported and is currently used in workflows.▾

---

Project Transfer (Export/Import)

Export projects as JSON files for backup or transfer, and import them into other environments.

GET/api/v1/unstract/{org_id}/prompt-studio/project-transfer/{tool_id}

Export a Prompt Studio project as a downloadable JSON file.▾

POST/api/v1/unstract/{org_id}/prompt-studio/project-transfer/

Import a Prompt Studio project from a JSON file. Uses multipart/form-data encoding.▾

POST/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/sync-prompts/

Sync prompts from an exported project JSON into an existing project. Optionally creates a backup copy before syncing.▾

---

Tool Export (for Deployment)

Export a Prompt Studio project as a tool to the registry for use in workflows and pipelines.

POST/api/v1/unstract/{org_id}/prompt-studio/export/{tool_id}

Export a Prompt Studio project as a tool to the tool registry, making it available for use in workflows.▾

GET/api/v1/unstract/{org_id}/prompt-studio/export/{tool_id}

Get export information for a project. Returns 204 No Content if the tool has not been exported.▾

---

Document Management

Upload, fetch, and delete documents associated with a Prompt Studio project.

POST/api/v1/unstract/{org_id}/prompt-studio/file/{tool_id}

Upload one or more files to a Prompt Studio project. Uses multipart/form-data encoding.▾

GET/api/v1/unstract/{org_id}/prompt-studio/file/{tool_id}

Fetch the contents of a document associated with a Prompt Studio project.▾

DELETE/api/v1/unstract/{org_id}/prompt-studio/file/{tool_id}

Delete a document from a Prompt Studio project.▾

---

Prompts

Create, retrieve, update, delete, and reorder prompts within a Prompt Studio project.

POST/api/v1/unstract/{org_id}/prompt-studio/prompt-studio-prompt/{tool_id}/

Create a new prompt within a Prompt Studio project.▾

GET/api/v1/unstract/{org_id}/prompt-studio/prompt/{prompt_id}/

Retrieve a single prompt by its ID.▾

PUT/api/v1/unstract/{org_id}/prompt-studio/prompt/{prompt_id}/

Fully update a prompt.▾

PATCH/api/v1/unstract/{org_id}/prompt-studio/prompt/{prompt_id}/

Partially update a prompt. Only provided fields are updated.▾

DELETE/api/v1/unstract/{org_id}/prompt-studio/prompt/{prompt_id}/

Delete a prompt. Returns 204 No Content on success.▾

POST/api/v1/unstract/{org_id}/prompt-studio/prompt/reorder/

Reorder a prompt by moving it from one sequence position to another.▾

---

LLM Profiles

Manage LLM profiles that define which models, vector stores, and retrieval strategies are used within a project. Maximum 4 profiles per project.

GET/api/v1/unstract/{org_id}/prompt-studio/prompt-studio-profile/{tool_id}/

List all LLM profiles for a Prompt Studio project.▾

PATCH/api/v1/unstract/{org_id}/prompt-studio/prompt-studio-profile/{tool_id}/

Set the default LLM profile for a Prompt Studio project.▾

POST/api/v1/unstract/{org_id}/prompt-studio/profilemanager/{tool_id}

Create a new LLM profile for a project. Maximum 4 profiles per project.▾

GET/api/v1/unstract/{org_id}/prompt-studio/profile-manager/{profile_id}/

Retrieve a single LLM profile by its ID.▾

PUT/api/v1/unstract/{org_id}/prompt-studio/profile-manager/{profile_id}/

Fully update an LLM profile.▾

PATCH/api/v1/unstract/{org_id}/prompt-studio/profile-manager/{profile_id}/

Partially update an LLM profile. Only provided fields are updated.▾

DELETE/api/v1/unstract/{org_id}/prompt-studio/profile-manager/{profile_id}/

Delete an LLM profile. Returns 204 No Content on success.▾

---

Execution

Index documents, run individual prompts, and perform single-pass extractions.

POST/api/v1/unstract/{org_id}/prompt-studio/index-document/{tool_id}

Index a document for retrieval-augmented generation within the project.▾

POST/api/v1/unstract/{org_id}/prompt-studio/fetch_response/{tool_id}

Run a single prompt against a document and fetch the LLM response.▾

POST/api/v1/unstract/{org_id}/prompt-studio/single-pass-extraction/{tool_id}

Run all active prompts against a document in a single pass. Requires single_pass_extraction_mode to be enabled on the project.▾

---

Other

Miscellaneous endpoints for shared users, deployment checks, and configuration choices.

GET/api/v1/unstract/{org_id}/prompt-studio/users/{tool_id}

List shared users for a Prompt Studio project.▾

GET/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/check_deployment_usage/

Check whether an exported tool is currently used in any deployments.▾

GET/api/v1/unstract/{org_id}/prompt-studio/select_choices/

Returns available dropdown field values for Prompt Studio forms (e.g., enforce_type options, prompt_type options).

GET/api/v1/unstract/{org_id}/prompt-studio/adapter-choices/

Returns available adapter choices for use in LLM profiles, including LLMs, embedding models, vector stores, and text extractors.

GET/api/v1/unstract/{org_id}/prompt-studio/{tool_id}/get_retrieval_strategies/

Returns metadata about available retrieval strategies for the project.▾