Agent Studio API reference

Request

curl -X POST https://create-your-agent.nishy.space/v1/agents/support-copilot/invoke \
  -H "Authorization: Bearer ak_…" \
  -H "Content-Type: application/json" \
  -d '{"messages": [
        {"role": "user", "content": "Hi, I ordered last week."},
        {"role": "assistant", "content": "Happy to help. What is the order number?"},
        {"role": "user", "content": "A1234"}
      ]}'

Response

{
  "agent": "support-copilot",
  "version": 3,
  "output": "Order A1234 shipped yesterday via UPS and arrives in 2 days.",
  "blocked": false,
  "blockedBy": null,
  "latencyMs": 1840,
  "trace": [
    { "stage": "shield", "name": "Injection shield", "status": "pass", "score": 0, "signals": [], "promptGuard": 0, "classifier": "safe", "ms": 412 },
    { "stage": "guardrail", "name": "Stay on topic", "phase": "input", "status": "pass", "reason": "Order status is on topic.", "ms": 380 },
    { "stage": "delegate", "tool": "delegate_to_order_tracker", "subagent": "Order Tracker", "task": "Look up order A1234", "result": "…", "ms": 630 },
    { "stage": "orchestrator", "steps": 2, "ms": 1100, "inputTokens": 938, "outputTokens": 71 }
  ]
}

When a stage blocks the request, blocked is true, blockedBy names it (for example shield:Injection shield or guardrail:Stay on topic), and output contains the blocked message you configured.

JavaScript and Python

// JavaScript (fetch)
const res = await fetch("https://create-your-agent.nishy.space/v1/agents/support-copilot/invoke", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.AGENT_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ input: "Where is my order #A1234?" }),
});
const { output, blocked, trace } = await res.json();

# Python (requests)
import os, requests
r = requests.post(
    "https://create-your-agent.nishy.space/v1/agents/support-copilot/invoke",
    headers={"Authorization": f"Bearer {os.environ['AGENT_KEY']}"},
    json={"input": "Where is my order #A1234?"},
)
print(r.json()["output"])

Status and errors

A GET to the same URL returns the agent name, whether it is deployed, and the current version, without needing a key.

Versions and keys

• Each Deploy creates an immutable version. The endpoint always serves the latest deployed version.
• Rotating the API key takes effect immediately for all versions.
• Runs are logged with input, output, trace, and latency and can be reviewed in the Runs tab.
• Limits per plan are listed on the pricing page.