How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bluejay Agents API

The Agents API from Bluejay — 9 operation(s) for agents.

Bluejay Agents API is one of 60 APIs that Bluejay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.getbluejay.ai.

9 operations 9 paths 13 schemas 1 DELETE3 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.getbluejay.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Bluejay Agents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key required to authenticate requests.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Agents 9
POST
/v1/add-agent
Add Agent
add_agent_v1_add_agent_post 1 param body → 200422
POST
/v1/update-agent
Update Agent
update_agent_v1_update_agent_post 1 param body → 200422
PUT
/v1/update-agent-by-external-id
Update Agent By External Id
update_agent_by_external_id_v1_update_agent_by_external_id_put 1 param body → 200422
GET
/v1/agents/{agent_id}
Get Agent
get_agent_v1_agents__agent_id__get 2 params → 200422
GET
/v1/agent-by-external-id/{external_id}
Get Agent By External Id
get_agent_by_external_id_v1_agent_by_external_id__external_id__get 2 params → 200422
GET
/v1/all-agents
Get All Agents
get_all_agents_v1_all_agents_get 1 param → 200422
DELETE
/v1/agent/{agent_id}
Delete Agent
delete_agent_v1_agent__agent_id__delete 2 params → 200422
POST
/v1/generate-http-webhook-key
Generate Http Webhook Key
generate_http_webhook_key_v1_generate_http_webhook_key_post 1 param body → 200422
POST
/v1/get-http-webhook-key
Get Http Webhook Key
get_http_webhook_key_v1_get_http_webhook_key_post 1 param body → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AgentPydantic (33 properties), AgentUpdateRequest (29 properties), AgentUpdateWithExternalIdRequest (28 properties), AgentRequest (28 properties). Each schema is shown below with its type and property counts.

AgentWebhookKeyResponse
object
Response model for agent webhook key
2 properties 2 required
AgentPydantic
object
33 properties 5 required
ValidationError
object
3 properties 3 required
ConnectionType
string
Enum representing the connection type of the agent
AgentResponse
object
3 properties 1 required
AgentUpdateRequest
object
29 properties 1 required
AgentUpdateResponse
object
3 properties 1 required
AgentRequest
object
28 properties 4 required
AgentWebhookKeyRequest
object
Request model for creating/getting an agent webhook key
2 properties
AgentUpdateWithExternalIdRequest
object
28 properties 1 required
AgentType
string
Enum representing the type of agent
AgentMode
string
Enum representing the mode of agent
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bluejay-agents-api-openapi.yml Raw ↑

Other APIs Bluejay publishes across the network.

Bluejay Alerts API
Bluejay Api Keys API
Bluejay bland API
Bluejay Call Logs API
Bluejay Check Queue Simulation Run API
Bluejay Communities API
Bluejay Compare Experiment Runs API
Bluejay Create Schedule API
Bluejay Create Simulation API
Bluejay Custom Metrics API
Bluejay Customer Personas API
Bluejay Customer Traits API
Where this information came from

This is an independent, third-party profile of Bluejay Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.