Provenance endpoint

Query Provenance SQL

POST/provenance/sql/

Example request

application/json

{
  "sql": "SELECT id, status FROM execution_runs WHERE status = :status",
  "parameters": {
    "status": "completed"
  },
  "page": 1,
  "pageSize": 50
}

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/provenance/sql/"

Supply a valid request.json before running this command.

200 OKapplication/json

Handler-checked response shape; values and optional fields vary.

{
  "columns": [
    {
      "name": "id",
      "type": "text"
    }
  ],
  "items": [],
  "page": 1,
  "pageSize": 50,
  "truncated": false,
  "elapsedMilliseconds": 0
}

Handler-checked behavior

Send a read-only sql query using SELECT or WITH; parameters supplies optional named values, and page/pageSize control results (at most 200 rows per page). Use GET /provenance/sql/schema/ to see allowed tables and columns. The service enforces a 10-second timeout and rejects writes or restricted fields with 400; an unavailable explorer returns 503. See provenance SQL guide.

Response shape

This shows an empty result for a query selecting id. columns follows the submitted SELECT list, and each item uses those column names. Pagination and elapsed time vary by query.

Related guide

See the Provenance guide for related tasks and context.