Skip to main content
POST
/
v1
/
evaluation
/
invoke
Invoke a pre-configured evaluation
curl --request POST \
  --url https://api.qualifire.ai/api/v1/evaluation/invoke \
  --header 'Content-Type: application/json' \
  --header 'X-Qualifire-API-Key: <api-key>' \
  --data '
{
  "evaluation_id": "<string>",
  "input": "<string>",
  "output": "<string>",
  "messages": [
    {
      "role": "system",
      "content": "<string>",
      "tool_calls": [
        {
          "function": {
            "name": "<string>",
            "arguments": {}
          },
          "id": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "available_tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "parameters": {}
    }
  ],
  "metadata": {}
}
'
{
  "status": "success",
  "score": 123,
  "evaluationResults": [
    {
      "type": "<string>",
      "results": [
        {
          "name": "<string>",
          "score": 123,
          "label": "<string>",
          "confidence_score": 123,
          "reason": "<string>",
          "flagged": true,
          "quote": "<string>",
          "data": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-Qualifire-API-Key
string
header
required

Body

application/json

Evaluation invoke request

At least one of input, output, or messages must be provided.

evaluation_id
string
required

The ID of the pre-configured evaluation to invoke

input
string

The input text (e.g., user prompt)

output
string

The output text (e.g., LLM response)

messages
object[]

Conversation messages for multi-turn evaluation

available_tools
object[]

List of tools available to the LLM

metadata
object

Optional key-value pairs (string values only) to attach to the evaluation invocation

Response

OK

status
enum<string>
required

Overall evaluation status

Available options:
success,
warning,
failed
score
number | null
required

Overall evaluation score (0-100)

evaluationResults
object[]
required