QANATIX
API ReferenceInteractive ReferenceEntities

Create entity

Create a new entity in any vertical. Auto-generates `description_llm` for embedding and `search_text` for full-text search. If a JSON Schema is registered for the vertical, `vertical_data` is validated against it.

POST
/api/v1/entities

Header Parameters

x-tenant-id?|
authorization?|

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/entities" \  -H "Content-Type: application/json" \  -d '{    "vertical": "manufacturing",    "entity_type": "product",    "name": "Deep Groove Ball Bearing 6205"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "vertical": "string",
  "entity_type": "string",
  "name": "string",
  "description": "string",
  "description_llm": "string",
  "source_url": "string",
  "source_type": "string",
  "source_name": "string",
  "source_id": "string",
  "status": "string",
  "vertical_data": {},
  "embedding_status": "string",
  "claim_status": "string",
  "data_quality_score": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}