Service Docs

Item API Documentation

Discovery and workflow endpoints exposed by the Item design portal. Machine-readable discovery is available through /.well-known/api-catalog and /openapi.json.

Auth Model

Interactive sign-in uses email OTP plus NextAuth session cookies. For agents, the site publishes a first-party OAuth 2.0 authorization server with Authorization Code + PKCE and a bearer-protected agent API rooted at /api/agent.

Endpoints

MethodPathAuthSummary
GET/.well-known/oauth-authorization-serverpublicOAuth 2.0 authorization server metadata for Authorization Code + PKCE.
GET/.well-known/oauth-protected-resourcepublicOAuth 2.0 protected resource metadata for the bearer-token agent API.
GET/api/healthpublicHealth status for automated availability checks.
GET/api/registrypublicCombined component registry manifest served to clients.
POST/api/chatpublicBrand-guideline assistant chat endpoint.
POST/api/send-otppublicStart email OTP login flow.
POST/api/verifypublicVerify OTP and mint a session token.
POST/api/request-accesspublicSubmit an access request for non-approved email domains.
GET/api/approve-accessoperatorOperator approval link for pending access requests.
POST/api/business-card-requestpublicSubmit a business card request workflow.
GET/api/agent/meoauthReturn the authenticated agent principal and granted scopes.
GET/api/agent/guidelinesoauthReturn public guideline summaries through a bearer-protected API.
GET/oauth/authorizesessionRender or complete the OAuth 2.0 authorization step.
POST/oauth/tokenpublicExchange an authorization code and PKCE verifier for a bearer token.
GET/oauth/jwks.jsonpublicPublish the JSON Web Key Set used to verify issued access tokens.
POST/mcppublicRead-only MCP endpoint for public discovery tools.
    API Documentation | Item Brand Guidelines