API Deployments
API Deployments expose workflows as REST APIs for document processing. Once a workflow is deployed, external systems can submit documents and receive structured extraction results.
Authentication
All endpoints require session or token auth.
Pagination: All list endpoints support page (default 1) and page_size (default 50, max 1000) query parameters.
Deployment Management
Create, list, update, and delete API deployments for workflows.
GET
/api/v1/unstract/{org_id}/api/deployment/List all API deployments for the current organization.▾
POST
/api/v1/unstract/{org_id}/api/deployment/Create a new API deployment for a workflow.▾
GET
/api/v1/unstract/{org_id}/api/deployment/{id}/Retrieve a single deployment by its ID.▾
PUT
/api/v1/unstract/{org_id}/api/deployment/{id}/Fully update a deployment. Requires owner permission.▾
PATCH
/api/v1/unstract/{org_id}/api/deployment/{id}/Partially update a deployment. Requires owner permission.▾
DELETE
/api/v1/unstract/{org_id}/api/deployment/{id}/Delete a deployment. Returns 204 on success. Requires owner permission.▾
GET
/api/v1/unstract/{org_id}/api/deployment/{id}/users/List users the deployment is shared with.▾
GET
/api/v1/unstract/{org_id}/api/deployment/by-prompt-studio-tool/Get deployments associated with a specific Prompt Studio tool.▾
GET
/api/v1/unstract/{org_id}/api/postman_collection/{id}/Download a Postman collection JSON file for the deployment.▾
Deployment API Keys
Manage API keys used to authenticate execution requests against deployments.
GET
/api/v1/unstract/{org_id}/api/keys/api/{api_id}/List all API keys for a specific deployment.▾
POST
/api/v1/unstract/{org_id}/api/keys/api/{api_id}/Create a new API key for a deployment or pipeline.▾
GET
/api/v1/unstract/{org_id}/api/keys/{id}/Retrieve a single API key by its ID.▾
PUT
/api/v1/unstract/{org_id}/api/keys/{id}/Update an API key. Typically used to toggle is_active or update description.▾
DELETE
/api/v1/unstract/{org_id}/api/keys/{id}/Delete an API key. Returns 204 on success.▾