Get input and context

Request

Retrieves the contextCheck with the input and the generated context around it

Security

clientCredentials or oAuth2Password

Path

idstringrequired

The ID of the contextCheck to retrieve.

GET

/contextChecks/{id}

curl -i -X GET \
  'https://api.blackbird.ai/compass/contextChecks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ContextCheck found

Bodyapplication/json

idstringrequired

The ID of the contextCheck

Example:"8115"

created_atstring, (date-time)required

The datetime the contextCheck was created

Example:"2024-10-10T15:20:33.307Z"

updated_atstring, (date-time)required

The datetime the contextCheck was last updated. Will just be the created date or completed date

Example:"2024-10-10T15:20:33.307Z"

inputstringrequired

The contextCheck to generate context for

Example:"Who is older, Biden or Trump?"

statusstringrequired

The status of the contextCheck context generation

Value:"processing"

Example:"processing"

Discriminator

Response

{
  "id": "8115",
  "created_at": "2024-10-10T15:20:33.307Z",
  "updated_at": "2024-10-10T15:20:33.307Z",
  "input": "Who is older, Biden or Trump?",
  "status": "processing"
}