Run Coverage

Trigger an asynchronous coverage evaluation run.

POST /api/v1/coverage/run

Run Coverage

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/coverage/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "referential_id": "<string>",
  "top_k": 5
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/coverage/run"

payload = {
    "referential_id": "<string>",
    "top_k": 5
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({referential_id: '<string>', top_k: 5})
};

fetch('https://{tenant_id}.api.useago.com/api/v1/coverage/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

202

{}

Authorizations

X-API-Key · string · header · required

Body

application/json

referential_id · string · required

top_k · integer · default: 5

Response

202 - application/json

Accepted

The response is of type Response · object.