Skip to main content
GET
/
v1
/
agents
/
{agent_id}
/
knowledge-bases
/
versions
/
{version}
/
labels
List Knowledge Base Version Labels Agent Scoped
curl --request GET \
  --url https://api.getbluejay.ai/v1/agents/{agent_id}/knowledge-bases/versions/{version}/labels \
  --header 'X-API-Key: <x-api-key>'
{
  "labels": [
    "<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.

## List Knowledge Base Version Labels — GET /v1/agents/{agent_id}/knowledge-bases/versions/{version}/labels

**Endpoint:** GET `https://api.getbluejay.ai/v1/agents/{agent_id}/knowledge-bases/versions/{version}/labels`
**Auth:** `X-API-Key` header

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

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

def list_knowledge_base_version_labels(agent_id: int, version: int, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/agents/{agent_id}/knowledge-bases/versions/{version}/labels"
    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.
Lists all labels associated with a specific knowledge base version.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
agent_id
integer
required
​
version
integer
required

Response

Successful Response

response wrapper for just a list of labels.

​
labels
string[]