---
title: "Generate Workspace Use Case Prompt"
method: POST
path: "/api/workspaces/{workspace_id}/usecases/generate-prompt"
---

# Generate Workspace Use Case Prompt

`POST /api/workspaces/{workspace_id}/usecases/generate-prompt`

## 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/generate-prompt`
- Auth: none declared

## Path parameters

- `workspace_id` string, required

## Request body

- UseCasePromptGenerationRequest
  - `description` string, required
  - `useCaseId` string, nullable
  - `sessionId` string, nullable
  - `context` PromptGenerationContext
    - `name` string, nullable
    - `useCaseGoals` string, nullable
    - `conclusion` string, nullable
    - `type` string, nullable

## Response `200`

Successful Response

- UseCasePromptGenerationResponse
  - `prompt` string, required
  - `agentInstructions` string
  - `greeting` string
  - `mainConversationFlow` string
  - `closing` string
  - `objectionHandling` string
  - `guardrails` string
  - `useCaseGoals` string
  - `conclusion` string
  - `promptAiGenerationsUsed` integer, required
  - `generationsRemaining` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-07-31** `7c9aff2501f3`: 1 info
  - endpoint added

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

---

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