Run a decision corpus against the pinned Provider

POST /v1/agents/{agent_id}/decision-corpora/{corpus_id}/runs

Sends the corpus to the Provider and model version the Agent's active version pins for the corpus's question set, as a decision.run job, and answers 202 with the run queued, its job_id and its Location (1.58.0). A run while another is queued or running answers 409 decision_run_in_progress; an Agent whose active version has no lane or not this set is decision_run_no_lane; an empty corpus is decision_corpus_empty. Metered as decision_request like any decision request, on the run (usage, 1.59.0) since a run has no Call and writes no Usage event; the job emits job.succeeded or job.failed, and the run, completed or failed, decision_run.completed (1.59.0 states the failed one).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/agents/agt_.../decision-corpora/dcp_.../runs" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../decision-corpora/dcp_.../runs`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/agents/agt_.../decision-corpora/dcp_.../runs",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: DecisionRunRequest.

Responses

Fields of the 202 answer

The shape is DecisionRun.