API explorer

Try the Halyard API

Pick an endpoint, edit the request and send it. Every response is a realistic sample, and the code panel turns your request into cURL, Node.js or Python you can paste straight into your project.

Test modeSandbox · no network25 endpoints · 2026-09-15

Response

Not sent yet

No response yet

Build the request and press Send request. You’ll see the status, timing, body and headers here.

Copy as

curl https://api.halyard.example/v3/jobs \  -H "Authorization: Bearer hy_test_51Hq8Zx2rTmV9cKpL3d" \  -H "Halyard-Version: 2026-09-15" \  -H "Idempotency-Key: signup-usr_8KfQ2" \  -H "Content-Type: application/json" \  -d '{    "queue": "emails",    "task": "send-welcome-email",    "payload": {      "user_id": "usr_8KfQ2"    }  }'

import { Halyard } from "@halyard/node"; const halyard = new Halyard(process.env.HALYARD_KEY, { apiVersion: "2026-09-15" }); const job = await halyard.jobs.create({  queue: "emails",  task: "send-welcome-email",  payload: { user_id: "usr_8KfQ2" },}, { idempotencyKey: "signup-usr_8KfQ2" });

import osfrom halyard import Halyard halyard = Halyard(os.environ["HALYARD_KEY"], api_version="2026-09-15") job = halyard.jobs.create(    queue="emails",    task="send-welcome-email",    payload={"user_id": "usr_8KfQ2"},    idempotency_key="signup-usr_8KfQ2",)

Create a job

Response