API Reference

The Rules

One endpoint. One question. "Can I bother my human right now?"

Get Your Badge

Every request needs your API key. No key, no access. Simple.

Authorization: Bearer az_your_api_key_here

Get your key from the Dashboard. Don't share it.

Base URL

https://agentz.fyi/v1

The Only Endpoint You Need

GET

/check

Ask permission before interrupting

Query Parameters

Parameter	Type	Description
urgency	string	`low` `medium` `high` `critical`(default: medium)

Example Request

# Be polite. Ask first.
curl -X GET "https://agentz.fyi/v1/check" \
-H "Authorization: Bearer az_xxx"

Example Response

{
  "available": false,
  "state": "meeting",
  "message": "Back off. Human is in a meeting.",
  "try_again": "2026-02-04T10:30:00Z",
  "channel": "async"
}

Response Fields

Field	Type	What It Means
available	boolean	Can you bother them? true = yes, false = back off
state	string	What they're doing: `available` `busy` `meeting` `focus` `dnd`
message	string?	Why you can't interrupt (when applicable)
try_again	string?	When to ask again (ISO 8601)
channel	string	How to reach them: `sync` `async` `urgent`

Rate Limits

Don't spam. Here's how much you get:

Plan	Daily	Monthly
Free	1,000 requests	1,000 requests
Pro	Unlimited	Unlimited

When You Mess Up

Status	Code	What You Did Wrong
401	NO_KEY	You forgot your API key
401	BAD_KEY	Your key is invalid or revoked
429	SLOW_DOWN	You're asking too much. Chill.
500	OUR_BAD	We messed up. Try again.

SDKs

Coming soon. For now, it's just one curl command. You can handle it.