Skip to main content

Ossa Core Api

OSSA Master API

Version: 0.1.9

OSSA - Open Standard for Software Agents

Master API specification for the OSSA platform, providing comprehensive orchestration, governance, and management capabilities for AI agents following OSSA v0.1.9 standards.

Key Capabilities

  • Agent Orchestration: Multi-agent coordination and workflow execution
  • Specification Engine: Agent manifest validation and certification
  • Registry Services: Global agent discovery and federation
  • Runtime Management: Production deployment and lifecycle management
  • Compliance & Governance: Policy enforcement and audit trails
  • Observability: Comprehensive monitoring and tracing

Base URL

  • https://api.llm.bluefly.io/ossa/v1 - Production server
  • https://api-dev.llm.bluefly.io/ossa/v1 - Development server
  • http://localhost:3000 - Local development

Authentication

This API requires authentication. See Authentication Guide for details.

Endpoints

Health check

GET /health

Responses:

200: undefined

500: undefined

503: undefined

Example:

curl -X GET "https://api.ossa.dev/health" \
  -H "Authorization: Bearer YOUR_TOKEN"

Readiness check

GET /health/ready

Responses:

200: undefined

500: undefined

503: undefined

Example:

curl -X GET "https://api.ossa.dev/health/ready" \
  -H "Authorization: Bearer YOUR_TOKEN"

Liveness check

GET /health/live

Responses:

200: undefined

500: undefined

503: undefined

Example:

curl -X GET "https://api.ossa.dev/health/live" \
  -H "Authorization: Bearer YOUR_TOKEN"

List registered agents

GET /agents

Description: Query the global agent registry

Parameters:

  • undefined (undefined) - No description
  • undefined (undefined) - No description
  • undefined (undefined) - No description
  • type (query) - No description
  • capability (query) - No description
  • status (query) - No description

Responses:

200: List of agents

{}

Example:

curl -X GET "https://api.ossa.dev/agents" \
  -H "Authorization: Bearer YOUR_TOKEN"

Register new agent

POST /agents

Request Body:

{}

Responses:

201: Agent registered

{}

400: undefined

Example:

curl -X POST "https://api.ossa.dev/agents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Get agent details

GET /agents/{agentId}

Parameters:

  • undefined (undefined) - No description

Responses:

200: Agent details

{}

404: undefined

Example:

curl -X GET "https://api.ossa.dev/agents/{agentId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Update agent registration

PUT /agents/{agentId}

Parameters:

  • undefined (undefined) - No description

Request Body:

{}

Responses:

200: Agent updated

{}

Example:

curl -X PUT "https://api.ossa.dev/agents/{agentId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Unregister agent

DELETE /agents/{agentId}

Parameters:

  • undefined (undefined) - No description

Responses:

204: Agent unregistered

Example:

curl -X DELETE "https://api.ossa.dev/agents/{agentId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

List workflows

GET /orchestration/workflows

Parameters:

  • undefined (undefined) - No description
  • undefined (undefined) - No description

Responses:

200: List of workflows

{}

Example:

curl -X GET "https://api.ossa.dev/orchestration/workflows" \
  -H "Authorization: Bearer YOUR_TOKEN"

Create workflow

POST /orchestration/workflows

Request Body:

{}

Responses:

201: Workflow created

{}

Example:

curl -X POST "https://api.ossa.dev/orchestration/workflows" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Execute workflow

POST /orchestration/workflows/{workflowId}/execute

Parameters:

  • workflowId (path, required) - No description

Request Body:

{}

Responses:

202: Workflow execution started

{}

Example:

curl -X POST "https://api.ossa.dev/orchestration/workflows/{workflowId}/execute" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Get execution status

GET /orchestration/executions/{executionId}

Parameters:

  • executionId (path, required) - No description

Responses:

200: Execution status

{}

Example:

curl -X GET "https://api.ossa.dev/orchestration/executions/{executionId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Validate agent manifest

POST /specification/validate

Description: Validate an OSSA agent manifest against the specification

Request Body:

{}

Responses:

200: Validation result

{}

400: undefined

500: undefined

Example:

curl -X POST "https://api.ossa.dev/specification/validate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

List agent taxonomies

GET /specification/taxonomies

Responses:

200: Available taxonomies

{}

Example:

curl -X GET "https://api.ossa.dev/specification/taxonomies" \
  -H "Authorization: Bearer YOUR_TOKEN"

List capability definitions

GET /specification/capabilities

Parameters:

  • category (query) - No description

Responses:

200: Capability definitions

{}

Example:

curl -X GET "https://api.ossa.dev/specification/capabilities" \
  -H "Authorization: Bearer YOUR_TOKEN"

Request certification

POST /certification/request

Request Body:

{}

Responses:

202: Certification request accepted

{}

Example:

curl -X POST "https://api.ossa.dev/certification/request" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Get certification status

GET /certification/{certificationId}

Parameters:

  • certificationId (path, required) - No description

Responses:

200: Certification details

{}

Example:

curl -X GET "https://api.ossa.dev/certification/{certificationId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

List governance policies

GET /governance/policies

Responses:

200: Governance policies

{}

Example:

curl -X GET "https://api.ossa.dev/governance/policies" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get agent compliance status

GET /governance/compliance/{agentId}

Parameters:

  • undefined (undefined) - No description

Responses:

200: Compliance status

{}

Example:

curl -X GET "https://api.ossa.dev/governance/compliance/{agentId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

List federation nodes

GET /federation/nodes

Responses:

200: Federation nodes

{}

Example:

curl -X GET "https://api.ossa.dev/federation/nodes" \
  -H "Authorization: Bearer YOUR_TOKEN"

Join federation

POST /federation/join

Request Body:

{}

Responses:

201: Joined federation

{}

Example:

curl -X POST "https://api.ossa.dev/federation/join" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request.json

Get platform metrics

GET /monitoring/metrics

Responses:

200: Platform metrics

{}

Example:

curl -X GET "https://api.ossa.dev/monitoring/metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get platform events

GET /monitoring/events

Parameters:

  • undefined (undefined) - No description
  • undefined (undefined) - No description
  • undefined (undefined) - No description

Responses:

200: Platform events

{}

Example:

curl -X GET "https://api.ossa.dev/monitoring/events" \
  -H "Authorization: Bearer YOUR_TOKEN"

Related Documentation