Skip to main content
POST
/
v1
/
screenings
Create a screening
curl --request POST \
  --url https://api.metal.ai/v1/screenings \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "company": "<string>",
  "deal": "<string>",
  "dataEntities": [
    "<string>"
  ],
  "workspace": "<string>",
  "skipSections": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "company": "<string>",
    "deal": "<string>",
    "status": "completed",
    "industry": "<string>",
    "sector": "<string>",
    "subsector": "<string>",
    "dataEntities": [
      "<string>"
    ],
    "sections": [
      {}
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "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
company
string
deal
string
dataEntities
string[]
workspace
string
skipSections
string[]

Response

Creates a new screening.

data
object