Knowledge Bases
- GETList Knowledge Bases
- POSTCreate Knowledge Base
- GETGet Knowledge Base
- DELDelete Knowledge Base
- PATCHPatch Knowledge Base
- GETList Upload Jobs
- GETGet Chunks
- POSTQuery Relevant Chunks
- POSTDelete Knowledge Base Data Source Connection
- POSTSubmit Upload Job with local files
- GETList Upload Jobs
- POSTSubmit Upload Job
- GETGet Upload Job
- POSTCancel Upload Job
- GETList Tracked Artifacts
- GETGet Tracked Artifact Details
- DELDelete Locally Stored Artifact
- PATCHPatch Artifact Information
- POSTTest Knowledge Base Data Source credentials
- POSTBatch Delete Locally Stored Artifacts
- GETList Upload Schedules
- POSTCreate Upload Schedule
- GETGet Upload Schedule
- DELDelete Upload Schedule
- PATCHUpdate Upload Schedule
Agents
Completions
Chat Completions
Models
- POSTExecute Model Deployment
- POSTGenerate text embedding
- POSTGenerate reranking
- POSTGenerate completion
- POSTGenerate chat completion
- GETList Model Deployments of a Model
- POSTDeploy Model
- GETGet Model usage by model name
- GETList All Model Deployments
- GETGet Model usage for one deployment
- POSTAdd model to group
- GETGet Model usage for a group
- GETList Models
- POSTCreate Model
- GETGet Model
- DELDelete Model
- PATCHUpdate Model
- GETList Model Groups
- POSTCreate Model Group
- GETGet Model Group
- DELDelete Model Group
- PATCHUpdate Model Group
- GETGet Deployment
- DELDelete Deployment
- PATCHUpdate Deployment
Accounts
Organizations
Question Sets
Evaluations
- POSTClaim Evaluation Task
- PATCHUpdate Evaluation Task
- GETGet Contributor Metrics
- GETList Contributor Metrics
- GETGet Evaluation Metrics
- GETGet Hybrid Evaluation Metrics
- GETList Evaluations
- POSTCreate Evaluation
- GETGet Evaluation
- DELDelete Evaluation
- PATCHUpdate Evaluation
- GETList Test Case Results
- POSTCreate Test Case Result
- POSTBatch Create Test Case Results
- GETGet Test Case Result
- PATCHUpdate Test Case Result
- GETGet Historical Test Case Result
- GETList Historical Test Case Results
Evaluation Configs
Evaluation Datasets
- GETList Evaluation Datasets
- POSTCreate Evaluation Dataset
- GETGet Evaluation Dataset
- DELDelete Evaluation Dataset
- PATCHUpdate Evaluation Dataset
- GETList Evaluation Dataset Versions
- POSTCreate Evaluation Dataset Version
- GETGet Evaluation Dataset Version
- GETList Test Cases
- POSTCreate Test Case
- POSTBatch Create Test Cases
- GETGet Test Case
- DELDelete Test Case
- PATCHUpdate Test Case
- GETGet Historical Test Case
- GETList Historical Test Cases
- DELWipe Full History of Test Cases
- GETList Autogenerated Draft Test Cases
- POSTCreate Autogenerated Draft Test Case
- GETGet Autogenerated Draft Test Case
- DELDelete Autogenerated Draft Test Case
- PATCHUpdate Autogenerated Draft Test Case
- POSTApprove Autogenerated Draft Test Case
- POSTPublish Latest Evaluation Dataset Version
- POSTApprove Auto Generated Test Cases Batch
- GETGet Evaluation Dataset Generation Jobs
- POSTCreate Evaluation Dataset Generation Job
- GETGet Evaluation Dataset Generation Job
- POSTCancel Evaluation Dataset Generation Job
- POSTPublish Evaluation Dataset Version
Studio Projects
Application Specs
Knowledge Base Data Sources
Model Templates V3 (Beta)
Model server
API Reference
Fine Tuning Jobs V3 (Beta)
Training Datasets V3 (Beta)
package deployments
Beta
Applications
- GETList Application Variants
- POSTCreate Application Variant
- GETGet Application Variant
- DELDelete Application Variant
- PATCHUpdate Application Variant
- GETList Application Deployments
- POSTCreate Application Deployment
- GETGet Application Deployment
- PATCHUpdate Application Deployment
- GETList Application Variant Reports
- POSTCreate Application Variant Report
- GETGet Application Variant Report
- GETList Application Test Case Outputs
- POSTBatch Create Application Test Case Outputs
- GETGet Application Test Case Output
- POSTCreate Application With Variant
- GETGet Application Schemas
- POSTProcess Application
- POSTProcess Application By Id
- POSTProcess Deployed Application For Thread
- POSTValidate Application
- GETList Application Threads
- POSTCreate New Application Thread
- POSTUpload Application Files
- PATCHPatch Application Variant Guardrails
ChatThreads
Interactions
MonitoringDashboard
Chat Themes
account groups
List Knowledge Bases
Description
Lists all knowledge bases owned by the authorized user.
Details
This API can be used to list all knowledge bases that have been created by the user. This API will return the details of all knowledge bases including their IDs, names, the embedding models they use, any metadata associated with the knowledge bases, and the timestamps for their creation, last-updated time.
Backwards Compatibility
V2 and V1 Knowledge Bases are entirely separate and not backwards compatible. Users who have existing V1 knowledge bases will need to migrate their data to V2 knowledge bases.
Optional search by account_id
Page number for pagination to be returned by the given endpoint. Starts at page 1
Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
Authorizations
Query Parameters
Optional search by account_id
Connections, ArtifactCount Page number for pagination to be returned by the given endpoint. Starts at page 1
x > 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 < x < 10000Response
The data returned for the current page.
The unique ID of the knowledge base
(Legacy) The unique ID of the underlying vector store. This is to allow for backwards compatibility with the V1 Vector Store APIs. This will be removed in the near future.
The name of the knowledge base
Metadata associated with the knowledge base
The timestamp at which the knowledge base was created
The timestamp at which the knowledge base was last updated
The data source connections associated with the knowledge base. Only returned with the view=Connections query parameter.
The status of the deletion job for this data source connection, if any.
DELETING, FAILED The date and time when the last upload for the data source was initiated.
The knowledge base data source entity.
S3 Name of the S3 bucket where the data is stored.
AWS region where the S3 bucket is located.
AWS account ID that owns the S3 bucket.
Prefix of the S3 bucket where the data is stored. If not specified, the entire bucket will be used.
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The user who originally created the entity.
The ID of the account that owns the given entity.
Number of artifacts in each of the various states, such as completed and failed for this knowledge base. This includes all data sources.
Number of artifacts in the chunking state
Number of artifacts in the embedding state
Number of artifacts uploaded successfully.
Previously: Number of artifacts awaiting upload. Note that this status will be deprecated soon and should show 0
Number of artifacts with upload in progress.
Number of artifacts that failed while being processed.
The total number of artifacts in the knowledge base. Only returned with the view=ArtifactCount query parameter.
Whether the knowledge base has been clustered.
The total number of items of the query
The current page number.
The number of items per page.