HydraCore
API by router

Evaluations

List Evaluations

GET
/v1/evaluations

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/evaluations'
Example Response
[  {    "config": {},    "created_at": "2019-08-24T14:15:22Z",    "description": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",    "name": "string",    "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",    "results_summary": {},    "status": "string",    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",    "updated_at": "2019-08-24T14:15:22Z"  }]

Create Evaluation

POST
/v1/evaluations

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
config?
Default{}
description?string|null
instance_id?|null
name*Name
Lengthlength <= 200
recipe_id?|null

Response Body

Successful Response

application/json
  1. response
config*
created_at*Created At
Formatdate-time
description*string|null
id*Id
Formatuuid
instance_id*|null
name*Name
recipe_id*|null
results_summary*|null
status*Status
tenant_id*Tenant Id
Formatuuid
updated_at*Updated At
Formatdate-time
Example Request
curl -X POST 'https://example.com/v1/evaluations' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "config": {},  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",  "name": "string",  "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",  "results_summary": {},  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z"}

Get Evaluation

GET
/v1/evaluations/{evaluation_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
config*
created_at*Created At
Formatdate-time
description*string|null
id*Id
Formatuuid
instance_id*|null
name*Name
recipe_id*|null
results_summary*|null
status*Status
tenant_id*Tenant Id
Formatuuid
updated_at*Updated At
Formatdate-time
Example Request
curl -X GET 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "config": {},  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",  "name": "string",  "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",  "results_summary": {},  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z"}

Delete Evaluation

DELETE
/v1/evaluations/{evaluation_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Get Results

GET
/v1/evaluations/{evaluation_id}/results

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/results'
Example Response
[  {    "agent_response": "string",    "created_at": "2019-08-24T14:15:22Z",    "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "latency_ms": 0,    "score": 0,    "score_reason": "string",    "status": "string",    "test_case_id": "738e7d5d-48c4-4b50-859a-47ff022bef7f",    "tokens_used": 0,    "tool_calls_made": [      {}    ]  }]

Override Score

PATCH
/v1/evaluations/{evaluation_id}/results/{result_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid
result_id*Result Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
score*Score
Range0 <= value <= 100
score_reason?string|null

Response Body

Successful Response

application/json
  1. response
agent_response*string|null
created_at*Created At
Formatdate-time
evaluation_id*Evaluation Id
Formatuuid
id*Id
Formatuuid
latency_ms*integer|null
score*integer|null
score_reason*string|null
status*Status
test_case_id*Test Case Id
Formatuuid
tokens_used*integer|null
tool_calls_made*array<>|null
Example Request
curl -X PATCH 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/results/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "score": 0}'
Example Response
{  "agent_response": "string",  "created_at": "2019-08-24T14:15:22Z",  "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "latency_ms": 0,  "score": 0,  "score_reason": "string",  "status": "string",  "test_case_id": "738e7d5d-48c4-4b50-859a-47ff022bef7f",  "tokens_used": 0,  "tool_calls_made": [    {}  ]}

Run Evaluation

POST
/v1/evaluations/{evaluation_id}/run

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
status*Status
task_id*Task Id
Example Request
curl -X POST 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/run'
Example Response
{  "status": "string",  "task_id": "string"}

List Test Cases

GET
/v1/evaluations/{evaluation_id}/test-cases

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases'
Example Response
[  {    "created_at": "2019-08-24T14:15:22Z",    "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",    "expected_behavior": "string",    "expected_tool_calls": [      {}    ],    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "input_message": "string",    "sort_order": 0,    "tags": [      null    ]  }]

Add Test Case

POST
/v1/evaluations/{evaluation_id}/test-cases

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
expected_behavior?string|null
expected_tool_calls?array<>|null
input_message*Input Message
sort_order?Sort Order
Default0
tags?array<string>
Default[]

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
evaluation_id*Evaluation Id
Formatuuid
expected_behavior*string|null
expected_tool_calls*array<>|null
id*Id
Formatuuid
input_message*Input Message
sort_order*Sort Order
tags*array<unknown>
Example Request
curl -X POST 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases' \  -H 'Content-Type: application/json' \  -d '{  "input_message": "string"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",  "expected_behavior": "string",  "expected_tool_calls": [    {}  ],  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "input_message": "string",  "sort_order": 0,  "tags": [    null  ]}

Delete Test Case

DELETE
/v1/evaluations/{evaluation_id}/test-cases/{case_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

evaluation_id*Evaluation Id
Formatuuid
case_id*Case Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Entity store

Previous Page

Finance

Next Page