Jump to Content
Guides
API and SDK Reference
Register
Log in
API and SDK Reference
Register
Log in
Guides
API and SDK Reference
Builders Parameters
Search
All
Pages
Start typing to search…
JUMP TO
Essentials
Structure and Authorization
Change Management
Quick Reference
Status and Error Codes
Pagination, Timeouts, and Date-Time Format
Resource IDs
deepset AI Platform
haystack
Get Available Components
get
Get Components Input Output
get
Create Components Dynamic Input Output
post
Run Component
post
Run Component Workspace
post
infrastructure
List OpenSearch credentials
get
Add OpenSearch credentials
post
Delete OpenSearch credentials
del
List Available S3 Credentials
get
Add S3 Credentials
post
Delete S3 Credentials
del
user
Read Users Me
get
Get Users
get
Read Users Me Workspace Permissions
get
Delete User
del
Get User
get
Update User Organization Role
patch
Remove Role
post
Assign Role
post
model_registry_token
Get Tokens
get
Remove Token
del
Get Token
get
Save Token
post
Update Token
put
organization
Get Organization
get
Invite User To Organization
post
Create Support Request
post
organization_permissions
Get Permissions
get
organization_roles
Get Roles
get
Add Role
post
Delete Role
del
Update Role
put
pipeline_utils
Generate Integrated Pipeline Yaml
post
prompts
List Public Prompt Templates
get
List Prompt Templates
get
Create Prompt Template
post
Delete Prompt Templates
del
Update Prompt Template
put
api_token
Get Tokens
get
Create Token
post
Remove Token
del
Retrieve Token
get
Patch Token
patch
Get Workspace Tokens
get
Create Workspace Token
post
Delete Workspace Token
del
Get Workspace Token
get
Update Workspace Token
patch
workspace
List Workspaces
get
Create Workspace
post
Delete Workspace
del
Get Workspace By Name
get
Search Count
get
Invite User To Workspace
post
Search History
get
Get Workspace Stats
get
Workspace Remove Role
post
datasets
List Datasets
get
Add Files
post
file
Delete Files
del
List Files
get
Upload File
post
Search Files
post
Update File Meta Bulk
post
Query Files
post
Delete File
del
Get File
get
Get File Meta
get
Update File Meta
patch
Upload Temporary File
post
Get Temporary File
get
indexes
Get Indexes
get
Create Index
post
Delete Index
del
Get Index By Name
get
Update Index
patch
Deploy Index
post
Count Documents
get
Query Documents
post
Get All Documents Stream
post
Get Document
get
Get Indexed Files By Status
get
Schedule Single File For Indexing
post
Get Pipeline Index Logs
get
Undeploy Index
post
Get Pipeline Visualization
get
Update Pipeline Visualization
put
pipeline_templates
List Pipeline Templates
get
Get Pipeline Template
get
pipeline
Validate Pipeline
post
List Pipelines
get
Create Pipeline
post
Delete Pipeline
del
Get Pipeline
get
Update Pipeline
patch
Activate Pipeline
post
Chat
post
Chat Stream
post
Set Default Pipeline
post
Deploy Pipeline
post
Get Pipeline Issues
get
Get Pipeline Index Metadata Types
get
Get Pipeline Logs
get
Get Pipeline Metadata Field Values
get
Get Pipeline Min Max Aggregation Metadata
get
Get Prompt
get
Get Prompts
get
Search
post
Search Stream
post
Pipeline Search History
get
Pipeline Search History Archive
get
Get Pipeline Stats
get
Undeploy Pipeline
post
Get Pipeline Yaml Configs
get
Get Pipeline Visualization
get
Update Pipeline Yaml
put
Update Pipeline Visualization
put
Delete Pipeline Search History
del
Pipeline Search History Result
get
search_session
Get Search Sessions
get
Create Search Session
post
Delete Search Session
del
shared_prototype
List Prototypes
get
Create Prototype
post
Revoke Shared Prototype
del
Get Shared Prototype
get
Edit Shared Prototype
patch
upload_session
Get Upload Sessions
get
Create Upload Session
post
Get Session Status
get
Close Session
put
Get Session Files
get
custom_components
Get Custom Components
get
Import Custom Components
post
Get Custom Component Logs
get
Get Custom Component
get
secrets
Get Secrets
get
Create Secret
post
Remove Secret
del
Get Integrations
get
Get Secret
get
Disconnect Integration
del
Update Secret
put
Connect Integration
post
Update Integration
put
Get Workspace Secrets
get
Create Workspace Secret
post
Get Workspace Integrations
get
Disconnect Workspace Integration
del
Connect Workspace Integration
post
Update Workspace Integration
put
Remove Workspace Secret
del
Get Workspace Secret
get
Update Workspace Secret
put
debug_tunnel
Start Debug Tunnel
post
feedback
Get Paginated Feedback
get
Create Feedback
post
Export Feedback
get
Get Pipeline Feedback Stats
get
Delete Feedback
del
Update Feedback
patch
feedback_tags
Get Paginated Tags
get
Create Tags
post
Delete Tags
del
health
Health
get
indexes
custom_components
feedback
model
Get Workspace Models
get
tools
Get Tools
get
Create Tool
post
Delete Tool
del
Get Tool
get
Update Tool
patch
Parse Tools
post
Validate Tool
post
Jobs
jobs
Get Jobs
get
Create Job
post
Delete Job
del
Get Job
get
Update Job
patch
Get Job Results
get
Get Export Job Results To Csv
get
Start Job
post
Get Presigned Download Url
get
shared_job
Create Shared Job
post
Get Shared Jobs
get
Get Shared Job
get
Edit Shared Job
patch
Revoke Shared Job
post
query_sets
Get Query Sets
get
Import Query Set
post
Get Query Set
get
Delete Query Set
del
Feedback
feedback
Get Paginated Feedback
get
Create Feedback
post
Export Feedback
get
Get Pipeline Feedback Stats
get
Delete Feedback
del
Update Feedback
patch
tags
Get Paginated Tags
get
Create Tags
post
Delete Tags
del
Custom Components
custom_components
Get Custom Components
get
Import Custom Components
post
Get Custom Component Logs
get
Get Custom Component
get
OPEN SOURCE SDK
Data Classes
Asynchronous Client
Synchronous Client
deepset AI Platform CLI
Builders Parameters
AnswerBuilder Parameters
DeepsetAnswerBuilder
PromptBuilder Parameters
