API Information

A reusable AI API for product applications.

CoreAI exposes a secure REST interface for submitting AI Jobs, checking status, and retrieving results while keeping AI processing asynchronous and observable.

Authentication

Bearer token access

Applications authenticate using API clients stored in the api_clients table. Secrets are loaded from AWS Secrets Manager and are not stored in source code.

Required

Authorization: Bearer xxxxx

REST Endpoints

Phase 1 AI Job API

POST /api/jobs/hello-world

Submit a Hello World AI Job and receive a queued job identifier.

GET /api/jobs/{id}

Retrieve an AI Job status and result metadata after worker processing.

Request Example

Submit AI Job

POST /api/jobs/hello-world
Content-Type: application/json
Authorization: Bearer xxxxx

{
  "message": "Hello World"
}

Response Example

Queued response

{
  "job_id": 1,
  "status": "queued"
}

Status Lookup

Retrieve AI Job

GET /api/jobs/1
Authorization: Bearer xxxxx

{
  "job_id": 1,
  "status": "complete",
  "result": {
    "message": "Hello World Processed"
  }
}

Error Codes

Human-readable failures

401 Invalid or missing bearer token

404 AI Job not found

422 Invalid request payload

500 Worker or platform error

Future Services

Planned AI Job types

alt_text blog_generation seo_metadata privacy_policy content_rewrite social_post embedding_generation