Get Prompt By Id

GET /v1/agents/{agent_id}/prompts/{prompt_id}

Get Prompt By Id

cURL

curl --request GET \
  --url https://api.getbluejay.ai/v1/agents/{agent_id}/prompts/{prompt_id} \
  --header 'X-API-Key: <x-api-key>'

200

{
  "prompt_text": "<string>",
  "version": 123,
  "agent_id": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "commit_message": "<string>",
  "labels": [
    "<string>"
  ],
  "metadata": {}
}

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 Prompt By Id — GET /v1/agents/{agent_id}/prompts/{prompt_id}

**Endpoint:** GET `https://api.getbluejay.ai/v1/agents/{agent_id}/prompts/{prompt_id}`
**Auth:** `X-API-Key` header

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

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

def get_prompt_by_id(agent_id: int, prompt_id: str, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/agents/{agent_id}/prompts/{prompt_id}"
    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.

Retrieves a prompt by its unique ID.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Path Parameters

agent_id · integer · required

prompt_id · string<uuid> · required

Response

200

application/json

Successful Response

response model for prompt without created_at.

prompt_text · string · required

the prompt content

version · integer · required

the version number of the prompt

agent_id · integer · required

id of the agent that owns this prompt

id · string<uuid> | null

the id of the prompt

commit_message · string | null

labels · string[] | null

labels associated with the prompt

metadata · Metadata · object

arbitrary JSON metadata