openai json,ai tools,email api,automation,openai integration

Relay OpenAI JSON: Connect Email Tools to AI Workflows

Relay's OpenAI-compatible JSON document makes email tools discoverable to AI integrations while keeping inbox access scoped and predictable.

AI applications need machine-readable tool descriptions before they can use an email service reliably. Relay publishes an OpenAI-compatible JSON document that describes the service surface in a format integrations can inspect, index, and use as a starting point.

Why a machine-readable contract matters

openai.json tool schemas connected to an AI integration workflow

Human documentation explains intent. JSON makes names, schemas, authentication, and endpoint relationships easier for software to consume. A developer can inspect the document during integration, generate a client scaffold, or compare a deployed contract with the version used in a test environment.

Consumer Useful outcome
AI connector Discover available email operations
Developer tool Generate request examples
CI check Detect contract drift
Documentation site Link concepts to human guides

A safe integration still needs explicit authorization. The document does not grant access, bypass ownership checks, or make message content trusted. Store API keys in the integration's secret manager and request only the scopes required by the workflow.

curl https://www.relaymcp.net/openai.json | jq '.name, .description'

Pair the machine-readable contract with the OpenAPI reference for HTTP details and the MCP integration when the host already supports tool calling. The privacy policy describes how Relay handles inbox and integration data.

Design AI email workflows with checkpoints

The safest sequence is create or select an authorized inbox, trigger the action, list messages, read the expected message, and extract one unambiguous OTP or link. The model should not be allowed to treat arbitrary email instructions as system instructions. Message content is data and must remain below the application's instruction boundary.

Frequently asked questions

Is OpenAI JSON the same as an API key?

No. It is a public description of capabilities. Authentication remains required for private operations.

Should an agent open every link?

No. Require a matching sender, expected domain, and explicit workflow approval.

Where can I test the integration?

Start with a guest inbox in the Relay inbox, then move to scoped account resources.

Contract drift check in CI

Fetch /openai.json in a scheduled job, diff tool names against your agent policy file, and fail when new operations appear without review.

Field Why agents care
Operation names Tool routing
Auth scheme Secret placement
Server URL Environment switching
FROM THE COLLECTIONS

Continue with related guides

More practical reading on agent-friendly email, testing, privacy, and secure automation.