Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Connections
Tools
Large Language Models (LLMs)
Evaluation Framework
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Assistants Runs
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Documents
- Vector Index
- Catalog Management
- Tenant Management
- Provisioning Lite
- Embed settings
- User Profiles
- Completions
- Background Tasks
- Auth
- Orchestrate Assistant
- Notifications
- IBM unique ID mapping
- Prompts
- Artifact Management
- Default Agent Settings
- all journey types
- Connections
- Tools
- Welcome Content
- LLM Analytics
- Internal Calls are listed over here
- Agents
- Agent Releases
- Agent Release Environments
- Agent Chat Starter Settings
- API Reference
- channel integration
- Knowledge-Bases
- Chat with Docs
- Toolkits
- Voice Configurations
- Models
- Model-Policy
- Credentials
- Teams Channel
- Twilio WhatsApp Channel
Legal notices
Catalog Management
Export Catalog Resources
POST
/
catalog
/
export
Copy
Ask AI
curl --request POST \
--url http://localhost/api/v1/catalog/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"resource_types": [
"__all__"
],
"filters": {}
}'
Copy
Ask AI
{
"metadata": {},
"assistants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"type": "<string>",
"nickname": "<string>",
"instructions": "<string>",
"user_start_messages": [
"<string>"
],
"llm_name": "<string>",
"llm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"models": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"display_name": "<string>",
"model_type": "chat",
"model_name": "<string>",
"api_base": "<string>",
"api_version": "<string>",
"deployment_id": "<string>",
"provider": "openai",
"config": {},
"provider_config": {},
"connection_id": "<string>"
}
],
"document_collections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>"
}
],
"vector_indices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"embeddings_model_name": "<string>",
"chunk_size": 123,
"chunk_overlap": 123,
"status": "not_ready",
"status_msg": "<string>",
"top_k": 10
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url http://localhost/api/v1/catalog/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"resource_types": [
"__all__"
],
"filters": {}
}'
Copy
Ask AI
{
"metadata": {},
"assistants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"type": "<string>",
"nickname": "<string>",
"instructions": "<string>",
"user_start_messages": [
"<string>"
],
"llm_name": "<string>",
"llm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"models": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"display_name": "<string>",
"model_type": "chat",
"model_name": "<string>",
"api_base": "<string>",
"api_version": "<string>",
"deployment_id": "<string>",
"provider": "openai",
"config": {},
"provider_config": {},
"connection_id": "<string>"
}
],
"document_collections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>"
}
],
"vector_indices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"tenant_name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"name": "<string>",
"embeddings_model_name": "<string>",
"chunk_size": 123,
"chunk_overlap": 123,
"status": "not_ready",
"status_msg": "<string>",
"top_k": 10
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.