Check what publishing the Agent draft would answer

POST /v1/agents/{agent_id}/publish-check

Runs every check of POST /v1/agents/{agent_id}/versions over the current draft, with the acknowledgements of the body, and answers the draft revision, whether the publish would pass, the code and details it would refuse with, and every lint finding of the template and its cross-checks against the Agent (1.58.0), so the publisher sees the warnings to acknowledge before publishing. From 1.63.0 it answers the Agent's publish gate (evaluation_gate) and, for a check with activate, the gate's refusal evaluation_gate_failed with the reason run_required. It writes nothing: no version, Audit event or Webhook event. An Agent of another Organization is not found.

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_.../publish-check" \
  -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_.../publish-check`, {
  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_.../publish-check",
    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: AgentPublishCheckRequest.

Responses

Fields of the 200 answer

The shape is AgentPublishCheck.