The Components Service API Reference

curl -X POST 
"https://api.example.com/components/vector/search?text=knowledge%20graph&embeddingModelId=amazon.titan-embed-text-v2:0&top_k=3"

[
  {
    "score": 0.8234,
    "metadata": {
      "AMAZON_BEDROCK_TEXT": "A knowledge graph represents information 
as interconnected entities and relationships...",
      "x-amz-bedrock-kb-source-uri": "s3://my-bucket/docs/knowledge-graphs.txt",
      "x-amz-bedrock-kb-data-source-id": "XIY1CD9O3U",
      "id": "chunk-abc123"
    },
    "id": "1%3A0%3Aabc123"
  },
  {
    "score": 0.7456,
    "metadata": {
      "AMAZON_BEDROCK_TEXT": "Graph databases store data as nodes and edges,
 enabling complex relationship queries...",
      "x-amz-bedrock-kb-source-uri": "s3://my-bucket/docs/graph-databases.txt",
      "x-amz-bedrock-kb-data-source-id": "XIY1CD9O3U",
      "id": "chunk-def456"
    },
    "id": "1%3A0%3Adef456"
  }
]

curl -X POST 
"https://api.example.com/components/vector/embed?text=GraphRAG%20enhances%20LLM%20responses&embeddingModelId=amazon.titan-embed-text-v2:0"

Returns an array of floating-point numbers (dimensions depend on the configured model).

[-0.011604309, -0.020996094, -0.01058197, -0.007511139, -0.023483276, ...]

The Components Service supports two embedding providers:

curl https://api.example.com/components/__health

{
  "status": "OK",
  "healthChecks": [
    {
      "status": "OK",
      "severity": "HIGH",
      "name": "OpenSearch Serverless Vector Store Healthcheck",
      "type": "opensearch-serverless",
      "impact": "Vector search and retrieval operations will fail if AOSS is unreachable.",
      "message": "AOSS index 'my-index' reachable",
      "description": "Validates AOSS connectivity and permissions via lightweight _search(size=0).",
      "troubleshooting":
 "https://api.example.com/__health/__trouble#opensearch-serverless-health"
    }
  ]
}

# Fast check (for frequent polling)
curl "https://api.example.com/components/__gtg"# 

Fresh check (for deployment verification)
curl "https://api.example.com/components/__gtg?cache=false"

HTTP 200

{"gtg":"OK"}

HTTP 503

{"gtg":"UNAVAILABLE"}

curl https://api.example.com/components/__about

{
  "description": "GraphRAG Components API, Embeddings and vector search endpoints.",
  "version": "1.2.0",
  "versionInfo": {
    "jdkVersion": "21"
  },
  "additionalInfo": {
    "Implementation-Title": "graphrag-components",
    "Spring-Boot-Version": "3.5.6"
  }
}

curl https://api.example.com/components/manifest-info