Skip to main content
POST
Enrich entity
Submits entity context and a JSON Schema. The response returns enrichment data that follows the requested schema when possible. The root schema must have type: "object" and at least one entry in properties. Lev8 accepts schemas up to 256 KiB, 12 levels, and 200 cumulative properties.

Example

Response

If the workflow completes without a generated result, the response can use success: false:

Generate fields with Pydantic

Authorizations

Authorization
string
header
default:lev8_live_...
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional stable key for this logical request. When omitted, lev8 generates one and returns it in the response Header.

Maximum string length: 128

Body

application/json
entity_context
string
required

Context for the entity to enrich, such as name, website, social handles, or an existing description. Maximum 16 KiB after trimming.

Minimum string length: 1
Example:

"Company: OpenAI\nWebsite: https://openai.com"

enrich_fields
object
required

Object JSON Schema that describes the fields to generate. Maximum 256 KiB, 12 levels, and 200 cumulative properties.

Example:

Response

Enrichment result.

success
boolean
required
Example:

true

answer
object
required

Enrichment result. Successful responses try to match the requested enrich_fields JSON Schema.

Example: