Skip to content
UltimateTeam.ai Docs

List Candidates

GET
/api/v1/knowledge-graph/candidates
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/knowledge-graph/candidates?limit=50' \
  --header 'X-API-Key: <X-API-Key>'

List unreviewed candidate entities in the staging queue.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Candidates Api V1 Knowledge Graph Candidates Get
Array<object>
CandidateResponse
object
confidence
required
Confidence
number
description
required
Any of:
string
entity_type
required
Entity Type
string
id
required
Id
string
name
required
Name
string
promoted_at
required
Any of:
string
rejection_reason
required
Any of:
string
Examplegenerated
[
  {
    "confidence": 1,
    "description": "example",
    "entity_type": "example",
    "id": "example",
    "name": "example",
    "promoted_at": "example",
    "rejection_reason": "example"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}