---
title: "Preview Workspace Usecase Import"
method: POST
path: "/api/workspaces/{workspace_id}/usecases/import-preview"
---

# Preview Workspace Usecase Import

`POST /api/workspaces/{workspace_id}/usecases/import-preview`

## Request

- Base URL: `https://api.outcallerai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.outcallerai.com/api/workspaces/{workspace_id}/usecases/import-preview`
- Auth: none declared

Describe what importing `request.sourceUseCaseId` would do. Performs no writes.

`workspace_id` in the path is the target; the source is named in the body. The caller
must be a member of the target and have editor access to the source use case, as clone
requires.

## Path parameters

- `workspace_id` string, required

## Request body

- UseCaseImportRequest: Copy a use case from another workspace the caller can also read. Every field other than the source pair is a replacement the caller picked in the import preview. Omitting one means "use the default", and the defaults never carry a workspace-scoped value across the workspace boundary.
  - `sourceWorkspaceId` string, required
  - `sourceUseCaseId` string, required
  - `name` string, nullable
  - `integrations` string[], nullable
  - `agentVoiceOverrides` object
  - `selectedKnowledgeBaseId` string, nullable

## Response `200`

Successful Response

- UseCaseImportPreviewResponse
  - `source` UseCaseImportSourceResponse, required
    - `workspaceId` string, required
    - `workspaceName` string, required
    - `useCaseId` string, required
    - `useCaseName` string, required
  - `target` UseCaseImportTargetResponse, required
    - `workspaceId` string, required
    - `workspaceName` string, required
    - `callProvider` string, required
  - `suggestedName` string, required
  - `copied` string[]
  - `dropped` UseCaseImportDroppedItem[]
    - `key` string, required
    - `reason` string, required
    - `sourceValue` string, nullable
  - `mappings` UseCaseImportMappingItem[]
    - `key` 'agents' | 'integrations' | 'knowledgeBase', required
    - `sourceAgents` UseCaseImportSourceAgent[]
      - `id` string, required
      - `name` string, required
      - `gender` string, nullable
      - `voiceIds` string[]
      - `voiceCompatible` boolean
    - `voiceOptions` UseCaseImportVoiceOption[]
      - `voiceId` string, required
      - `name` string, required
      - `provider` string, nullable
      - `gender` string, nullable
    - `sourceSlugs` string[]
    - `availableSlugs` string[]
    - `missingSlugs` string[]
    - `sourceKnowledgeBaseName` string, nullable
    - `knowledgeBaseOptions` UseCaseImportKnowledgeBaseOption[]
      - `id` string, required
      - `name` string, required
    - `providerCompatible` boolean
  - `warnings` string[]

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-14** `3352c1282935`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/outcallerai/apis/fastapi/changes/api/workspaces/:workspace_id/usecases/import-preview/post.md)

---

[API](https://skmtc.dev/outcallerai/apis/fastapi.md) - [All operations](https://skmtc.dev/outcallerai/apis/fastapi/llms.txt) - [OpenAPI document](https://skmtc.dev/outcallerai/apis/fastapi/revisions/40736cf433b4?raw)