API Reference

Workflows

Copy page

Workflow trigger endpoints

Process workflow jobs

GET
/api/workflow/process

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Response Body

curl -X GET "https://api.pilot.inkeep.com/api/workflow/process"
Empty

Trigger evaluations on conversations by evaluation job config

POST
/evals/tenants/{tenantId}/projects/{projectId}/evaluate-conversations-by-job

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Path Parameters

tenantId*string

Tenant identifier

projectId*string

Project identifier

Request Body

application/json

evaluationJobConfigId*string
evaluatorIds*array<>
jobFilters?

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/evals/tenants/tenant_123/projects/project_456/evaluate-conversations-by-job" \  -H "Content-Type: application/json" \  -d '{    "evaluationJobConfigId": "string",    "evaluatorIds": [      "string"    ]  }'
{
  "conversationCount": 0,
  "evaluationRunId": "string",
  "failed": 0,
  "queued": 0
}
Empty
Empty

Run dataset items

POST
/evals/tenants/{tenantId}/projects/{projectId}/run-dataset-items

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Path Parameters

tenantId*string

Tenant identifier

projectId*string

Project identifier

Request Body

application/json

datasetRunId*string
evaluationRunId?string
evaluatorIds?array<>
items*array<>

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/evals/tenants/tenant_123/projects/project_456/run-dataset-items" \  -H "Content-Type: application/json" \  -d '{    "datasetRunId": "string",    "items": [      {        "agentId": "string"      }    ]  }'
{
  "datasetRunId": "string",
  "failed": 0,
  "queued": 0
}
Empty
Empty