Skip to main content
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.

## Get Workflows — GET /v1/workflows

> **What this endpoint does:** Get all workflows, optionally filtered by agent.

**Endpoint:** GET `https://api.getbluejay.ai/v1/workflows`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |

Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/get-workflows and include any optional parameters (e.g., `agent_id`) that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.

### Example
**Simple GET:**
```python
import requests

def get_workflows(api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/workflows"
    headers = {"X-API-Key": api_key}
    response = requests.get(url, headers=headers)
    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 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.
GET /v1/workflows lists workflows for your organization, optionally filtered by agent_id. This route is deprecated for new integrations. For conversation-path graphs (React Flow under /v1/workflow), use List workflows instead. See the OpenAPI schema on this page for the response shape.