Generate objectives

Generate objectives for a test case from its intent.

POST /v1/generate-objectives

Generate Objectives Endpoint

cURL

curl --request POST \
  --url https://api.getbluejay.ai/v1/generate-objectives \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "test_case_id": 123
}
'

200

{
  "test_case_id": 123,
  "objectives": "<string>"
}

Integration Prompt for AI Agents

# Bluejay — Testing & Monitoring Platform for Conversational AI Agents

You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.

## Generate objectives — POST /v1/generate-objectives

> **What this endpoint does:** Generate objectives for a test case from its intent. **400** if the test case tags indicate workflow playback (tag lowercased contains `workflow`): workflow-tagged digital humans use enriched playback on the agent; objectives are not applicable.

**Endpoint:** POST `https://api.getbluejay.ai/v1/generate-objectives`
**Auth:** `X-API-Key` header
**Content-Type:** application/json

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| test_case_id | integer | ID of the test case |

### Request Body (required fields)
```json
{
  "test_case_id": 123
}
```

Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/generate-objectives. This request body only requires `test_case_id`.

### Example
**POST with body:**
```python
import requests

def generate_objectives(payload: dict, api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/generate-objectives"
    headers = {"X-API-Key": api_key}
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status()
    return response.json()
```

### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 400: Workflow-tagged test case: objectives not applicable; 422: Validation Error.

### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?

Then implement the integration, export it, and confirm it compiles/passes lint.

For some workflow-driven digital humans this route returns 400; see the constraints above and the OpenAPI description.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Body

application/json

Request model for generating objectives.

test_case_id · integer · required

ID of the test case

Response

200

application/json

Successful Response

Response model for generating objectives.

test_case_id · integer · required

ID of the test case

objectives · string | null

The generated objectives as a formatted string