Adapters
Adapter endpoints manage connections to LLMs, embedding models, vector databases, and text extractors. Adapters store encrypted credentials and provide a unified interface for integrating external services with Unstract.
Valid adapter types: LLM, EMBEDDING, VECTOR_DB, X2TEXT, OCR.
Adapter Discovery
Discover supported adapters, retrieve configuration schemas, and test adapter connectivity.
GET
/api/v1/unstract/{org_id}/supported_adapters/List all supported adapters, optionally filtered by adapter type. Returns 400 if adapter_type is missing or invalid.▾
GET
/api/v1/unstract/{org_id}/adapter_schema/Retrieve the JSON Schema describing the configuration fields for a specific adapter. Returns 400 if id is missing or invalid.▾
POST
/api/v1/unstract/{org_id}/test_adapters/Test an adapter configuration to verify that the provided credentials and settings are valid.▾
Adapter Instances
Create, list, retrieve, update, and delete adapter instances. Each instance stores encrypted credentials for a specific adapter.
GET
/api/v1/unstract/{org_id}/adapter/List all adapter instances for the current organization, optionally filtered by adapter type.▾
POST
/api/v1/unstract/{org_id}/adapter/Create a new adapter instance. Credentials are encrypted with Fernet before storage. If no default exists for the user and adapter type, this instance is automatically set as the default. Returns 201 on success.▾
GET
/api/v1/unstract/{org_id}/adapter/{id}/Retrieve a single adapter instance by ID, including decrypted adapter metadata.▾
PUT
/api/v1/unstract/{org_id}/adapter/{id}/Fully update an existing adapter instance. All fields from the create endpoint apply.▾
PATCH
/api/v1/unstract/{org_id}/adapter/{id}/Partially update an adapter instance. Only the provided fields are modified.▾
DELETE
/api/v1/unstract/{org_id}/adapter/{id}/Delete an adapter instance. Returns 204 No Content on success. Returns 500 if the adapter is configured as a default, or 409 if the adapter is in use by a workflow or prompt studio project.▾
Adapter Info & Sharing
Retrieve adapter information and manage sharing settings.
GET
/api/v1/unstract/{org_id}/adapter/info/{id}/Get summary information for an adapter instance, including context window size for LLM adapters.▾
GET
/api/v1/unstract/{org_id}/adapter/users/{id}/List users that an adapter instance is shared with.▾
Default Triad
Manage default adapter selections per type. The default triad determines which adapters are used when no specific adapter is specified.
GET
/api/v1/unstract/{org_id}/adapter/default_triad/Retrieve the current default adapter configuration. Returns an empty object if no defaults are configured.▾
POST
/api/v1/unstract/{org_id}/adapter/default_triad/Configure or update default adapters. Only the provided fields are updated. Returns 200 OK with an empty body.▾
Adapter Types
| Value | Description |
|---|---|
LLM | Large Language Model |
EMBEDDING | Embedding model |
VECTOR_DB | Vector database |
X2TEXT | Document-to-text extraction |
OCR | OCR engine |