---
title: "Export Catalog Resources"
method: POST
path: "/v1/catalog/export"
tags: ["Catalog Management"]
---

# Export Catalog Resources

`POST /v1/catalog/export`

## Request body

- CatalogExportRequest
  - `resource_types` CatalogResourceType[], nullable
  - `filters` object, nullable

## Response `200`

Successful Response

- CatalogExport
  - `metadata` object, required
  - `assistants` union[], nullable
    - union
      - CustomAssistantOut
        - `id` string, uuid, nullable
        - `tenant_id` string, nullable
        - `tenant_name` string, nullable
        - `title` string, nullable
        - `description` string, nullable
        - `created_on` string, date-time, nullable
        - `created_by` string, nullable
        - `created_by_username` string, nullable
        - `updated_at` string, date-time, nullable
        - `tags` string[], nullable
        - `name` string, nullable
        - `type` string, required
        - `nickname` string, nullable
        - `instructions` string, nullable
        - `user_start_messages` string[], nullable
        - `llm_name` string, nullable
        - `llm_id` string, uuid, nullable
        - `context_access_enabled` boolean — Enable access to context variables for this agent
        - `context_variables` string[] — List of context variable names that this agent can access
      - WatsonAssistantOut
        - `id` string, uuid, nullable
        - `tenant_id` string, nullable
        - `tenant_name` string, nullable
        - `title` string, nullable
        - `description` string, nullable
        - `created_on` string, date-time, nullable
        - `created_by` string, nullable
        - `created_by_username` string, nullable
        - `updated_at` string, date-time, nullable
        - `tags` string[], nullable
        - `name` string, nullable
        - `type` string, required
        - `provider` string, nullable
        - `nickname` string, nullable
        - `api_key` string, nullable
        - `service_instance_url` string, nullable
        - `assistant_id` string, nullable
        - `environment_id` string, nullable
        - `api_version` string, nullable
        - `auth_type` 'ICP_IAM' | 'IBM_CLOUD_IAM' | 'MCSP' | 'BEARER_TOKEN' | '<hidden>'
        - `authorization_url` string, nullable
        - `crn` string, nullable
        - `intent` string, nullable
        - `action_title` string, nullable
        - `search_stickiness` boolean
        - `shareable_context` boolean
        - `hidden` boolean
        - `message_context` object, nullable
        - `connection_id` string, nullable
        - `context_access_enabled` boolean — Enable access to context variables for this agent
        - `context_variables` string[] — List of context variable names that this agent can access
  - `models` ModelOut[], nullable
    - `id` string, uuid, nullable
    - `tenant_id` string, nullable
    - `tenant_name` string, nullable
    - `title` string, nullable
    - `description` string, nullable
    - `created_on` string, date-time, nullable
    - `created_by` string, nullable
    - `created_by_username` string, nullable
    - `updated_at` string, date-time, nullable
    - `tags` string[], nullable
    - `name` string, nullable
    - `display_name` string, nullable
    - `model_type` 'chat' | 'chat_vision' | 'completion' | 'embedding'
    - `model_name` string, required
    - `api_base` string, nullable
    - `api_version` string, nullable
    - `deployment_id` string, nullable
    - `provider` 'openai' | 'anthropic' | 'azure-openai' | 'azure-ai' | 'anyscale' | 'cohere' | 'cerebras' | 'palm' | 'google' | 'together-ai' | 'mistral-ai' | 'perplexity-ai' | 'stability-ai' | 'nomic' | 'ollama' | 'bedrock' | 'ai21' | 'groq' | 'segmind' | 'vertex-ai' | 'deepinfra' | 'novita-ai' | 'fireworks-ai' | 'deepseek' | 'voyage' | 'vllm' | 'jina' | 'reka-ai' | 'moonshot' | 'openrouter' | 'lingyi' | 'zhipu' | 'monsterapi' | 'predibase' | 'huggingface' | 'github' | 'deepbricks' | 'siliconflow' | 'workers-ai' | 'ibm_bam' | 'watsonx' | 'mistralai' | 'specialized_routing_model' | 'product_rag' | 'x-ai'
    - `config` object, nullable
    - `provider_config` object, nullable
    - `connection_id` string, nullable
  - `document_collections` DocumentCollection[], nullable
    - `id` string, uuid, nullable
    - `tenant_id` string, nullable
    - `tenant_name` string, nullable
    - `title` string, nullable
    - `description` string, nullable
    - `created_on` string, date-time, nullable
    - `created_by` string, nullable
    - `created_by_username` string, nullable
    - `updated_at` string, date-time, nullable
    - `tags` string[], nullable
    - `name` string, required
  - `vector_indices` VectorIndex[], nullable
    - `id` string, uuid, nullable
    - `tenant_id` string, nullable
    - `tenant_name` string, nullable
    - `title` string, nullable
    - `description` string, nullable
    - `created_on` string, date-time, nullable
    - `created_by` string, nullable
    - `created_by_username` string, nullable
    - `updated_at` string, date-time, nullable
    - `tags` string[], nullable
    - `name` string, required
    - `embeddings_model_name` string, required
    - `chunk_size` integer, nullable
    - `chunk_overlap` integer, nullable
    - `status` 'ready' | 'not_ready' | 'rebuilding' | 'error' | 'update_pending'
    - `status_msg` string, nullable
    - `top_k` integer
    - `extraction_strategy` 'express' | 'standard' | 'high_quality'

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)