Skip to main content
POST
/
v1
/
enrichments
Create an enrichment
curl --request POST \
  --url https://api.metal.ai/v1/enrichments \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "resourceType": "company",
  "resourceId": "<string>",
  "property": "description",
  "value": "<unknown>",
  "source": "<string>",
  "sourceId": "<string>",
  "provider": "<string>",
  "confidence": 0.5,
  "rationale": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "property": "<string>",
    "value": "<unknown>",
    "provider": "<string>",
    "source": "<string>",
    "sourceId": "<string>",
    "confidence": 123,
    "capturedOn": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-metal-client-id
string
header
required

The Client ID of your API key.

x-metal-api-key
string
header
required

The secret value of your API key.

Body

application/json
resourceType
string
required
Example:

"company"

resourceId
string
required
property
string
required
Example:

"description"

value
any
required

The value to store.

source
string
required
sourceId
string
required
provider
string
confidence
number
Required range: 0 <= x <= 1
rationale
string

Response

Records an enriched property value on a resource.

data
object