esyURL Auth API
The auth API from esyURL — 7 operation(s) for auth.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/esyurl-fyi:esyurl-fyi-auth-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Esyurl Fyi Auth API
version: 2.0.0
contact:
name: esyURL
email: contact@esyurl.fyi
url: https://esyurl.fyi/about/contact
x-guidance: 'Get an API key first: follow /auth.md (agents sign themselves up, no human needed). Then POST /v1/links with {"targetUrl": "...", "slug": "..."} for a short link and GET /v1/links/{id}/qr for its QR code. PUT /v1/domain {"domain": "go.example.com"} sets a custom domain; for self-signed-up tenants it answers 402 and is paid with x402 (USDC), once per domain. The full guide is /llms.txt.'
description: 'Operations tagged auth across 2 of this provider''s published API definitions: openapi.json, esyurl-fyi-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://esyurl.fyi
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Auth
paths:
/auth.md:
get:
tags:
- Auth
summary: 'auth.md: how an agent signs itself up (the agentic-registration skill document)'
security: []
responses:
'200':
description: Markdown
content:
text/markdown:
schema:
type: string
operationId: getAuthMd
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/.well-known/oauth-protected-resource:
get:
tags:
- Auth
summary: Protected Resource Metadata (RFC 9728)
security: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
operationId: getWellKnownOauthProtectedResource
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/.well-known/oauth-authorization-server:
get:
tags:
- Auth
summary: Authorization Server Metadata (RFC 8414) with the auth.md `agent_auth` block
security: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
operationId: getWellKnownOauthAuthorizationServer
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/agent/identity:
post:
tags:
- Auth
summary: 'Register an agent: creates a tenant, returns an identity_assertion'
description: Only `{"type":"anonymous"}`. Rate limited per client IP (429 `rate_limited` with Retry-After). See /auth.md.
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- type
properties:
type:
const: anonymous
responses:
'200':
description: Registered
content:
application/json:
schema:
$ref: '#/components/schemas/AgentRegistration'
'400':
description: Refused
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
'429':
description: Rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
operationId: postAgentIdentity
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/agent/identity/claim:
post:
tags:
- Auth
summary: 'Start the claim ceremony: emails a sign-in link to the human, returns the…'
description: Only when the deployment sends email (the AS metadata then lists `claim_endpoint`); 404 otherwise.
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- claim_token
- email
properties:
claim_token:
type: string
email:
type: string
format: email
responses:
'200':
description: Initiated
content:
application/json:
schema:
type: object
'400':
description: invalid_claim_token, claimed_or_in_flight, invalid_request
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
'404':
description: The claim ceremony is not available
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
'410':
description: claim_expired
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
'429':
description: rate_limited
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
operationId: postAgentIdentityClaim
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/oauth2/token:
post:
tags:
- Auth
summary: Exchange an identity_assertion for an esy_ API key, or poll the claim ceremony
security: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- grant_type
properties:
grant_type:
type: string
enum:
- urn:ietf:params:oauth:grant-type:jwt-bearer
- urn:workos:agent-auth:grant-type:claim
assertion:
type: string
claim_token:
type: string
responses:
'200':
description: Token
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
description: An esy_ API key; does not expire
token_type:
const: Bearer
scope:
type: string
tenant_id:
type: string
identity_assertion:
type: string
assertion_expires:
type: string
format: date-time
'400':
description: invalid_request, invalid_grant, unsupported_grant_type, authorization_pending, slow_down, expired_token
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
operationId: postOauth2Token
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
/oauth2/revoke:
post:
tags:
- Auth
summary: Revoke an API key (RFC 7009); 200 whether or not it existed
security: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- token
properties:
token:
type: string
token_type_hint:
type: string
responses:
'200':
description: Revoked (or unknown)
'400':
description: invalid_request
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthError'
operationId: postOauth2Revoke
x-operation-id-source: derived
servers:
- url: https://esyurl.fyi
components:
schemas:
AgentRegistration:
type: object
properties:
registration_id:
type: string
registration_type:
const: anonymous
identity_assertion:
type: string
description: Service-signed JWT; exchange it at /oauth2/token
assertion_expires:
type: string
format: date-time
pre_claim_scopes:
type: array
items:
type: string
claim_url:
type: string
description: Only when the claim ceremony is available
claim_token:
type: string
description: Returned once
claim_token_expires:
type: string
format: date-time
post_claim_scopes:
type: array
items:
type: string
tenant_id:
type: string
OAuthError:
type: object
required:
- error
properties:
error:
type: string
error_description:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key `esy_{keyId}_{secret}`, from an operator or from agent self-sign-up (/auth.md)
apiKeyHeader:
type: apiKey
in: header
name: x-api-key
x-refined-from:
- openapi.json
- esyurl-fyi-openapi.json