Bluejay Labels API
The Labels API from Bluejay — 2 operation(s) for labels.
OpenAPI Specification
openapi: 3.1.0
info:
title: Bluejay Agents Labels API
description: Bluejay API
version: 0.1.0
servers:
- url: https://api.getbluejay.ai
description: Production server
security:
- apiKeyAuth: []
tags:
- name: Labels
paths:
/v1/agents/{agent_id}/labels:
post:
tags:
- Labels
summary: Create Label
description: create a free-standing label for an agent (not attached to any prompt or knowledge base).
operationId: create_label_v1_agents__agent_id__labels_post
security:
- HTTPBearer: []
parameters:
- name: agent_id
in: path
required: true
schema:
type: integer
title: Agent Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLabelBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LabelPydantic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Labels
summary: List Labels
description: list all free-standing labels for an agent; filter by substring with q.
operationId: list_labels_v1_agents__agent_id__labels_get
security:
- HTTPBearer: []
parameters:
- name: agent_id
in: path
required: true
schema:
type: integer
title: Agent Id
- name: q
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Q
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LabelPydantic'
title: Response List Labels V1 Agents Agent Id Labels Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/agents/{agent_id}/labels/{label_id}:
get:
tags:
- Labels
summary: Get Label By Id
operationId: get_label_by_id_v1_agents__agent_id__labels__label_id__get
security:
- HTTPBearer: []
parameters:
- name: agent_id
in: path
required: true
schema:
type: integer
title: Agent Id
- name: label_id
in: path
required: true
schema:
type: string
title: Label Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LabelPydantic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Labels
summary: Update Label
description: rename a free-standing label; reserved labels are not allowed as targets.
operationId: update_label_v1_agents__agent_id__labels__label_id__put
security:
- HTTPBearer: []
parameters:
- name: agent_id
in: path
required: true
schema:
type: integer
title: Agent Id
- name: label_id
in: path
required: true
schema:
type: string
title: Label Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLabelBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LabelPydantic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Labels
summary: Delete Label
description: delete a free-standing label; cannot delete reserved labels; cannot delete if associated.
operationId: delete_label_v1_agents__agent_id__labels__label_id__delete
security:
- HTTPBearer: []
parameters:
- name: agent_id
in: path
required: true
schema:
type: integer
title: Agent Id
- name: label_id
in: path
required: true
schema:
type: string
title: Label Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
CreateLabelBody:
properties:
label_text:
type: string
title: Label Text
description: text for the label
type: object
required:
- label_text
title: CreateLabelBody
UpdateLabelBody:
properties:
label_text:
type: string
title: Label Text
description: new text for the label
type: object
required:
- label_text
title: UpdateLabelBody
LabelPydantic:
properties:
id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Id
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
agent_id:
type: integer
title: Agent Id
label_text:
type: string
title: Label Text
prompt_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Prompt Id
knowledge_base_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Knowledge Base Id
color:
anyOf:
- type: string
- type: 'null'
title: Color
type: object
required:
- agent_id
- label_text
title: LabelPydantic
description: Represents a label record stored in the `labels` table.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key required to authenticate requests.