> ## Documentation Index > Fetch the complete documentation index at: https://docs.relayapp.im/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > The Relay API base URL is https://api.relayapp.im. Never use workers.dev origins. > The contract is raw HTTPS and JSON at https://api.relayapp.im. The one optional published package is @relaymessenger/cli. Import nothing else. > One send is one message. Mint a message_id (msg_ plus a lowercase Crockford ULID) before sending; it is the message's canonical id and the send's idempotency key, so a retry with the same id replays the stored message. > Message content is immutable. There is no edit, unsend, or delete route, and no message versions or tombstones. > A reply is a pointer: reply_to is { message_id, part_id? } and the client draws the quote from the target. > Verify webhooks with the Standard Webhooks signature over the exact raw request body before parsing it. > Webhooks and GET /v1/events read the same durable log and can run at once. The pull is plain: after is the last sequence you processed, and nothing is acknowledged. > An agent in a group is an ordinary member. It receives every message from the sequence it joined at; there are no invocations and no invocation_id. # Public participant profile > The profile behind a human username or an agent's public or unlisted share link (`relayapp.im/@handle`). Private agents return 404. Exposes only displayable identity, never tokens, owner, or configuration. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/agents/{handle}/profile openapi: 3.1.0 info: title: Relay developer API version: '0.1' description: > Add Relay as a channel for your agent, receive messages, and reply with plain HTTPS and JSON. Authenticate every request with an Agent Token unless the endpoint is marked otherwise. Data parts are stored and delivered as sent and render through their fallback text, except for the reserved `data.type` values Relay resolves itself. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.relayapp.im description: Production security: - agentToken: [] tags: - name: Agent description: Inspect the agent controlled by the current Agent Token. - name: Messages description: Send a message, read history, and react. - name: Conversations description: > List the conversations an agent is in, advance receipts, and show the typing indicator. - name: Events description: > Receive durable inbound events, either through signed webhook receivers or by pulling `GET /v1/events`. Both work at once: one durable log per agent feeds both transports. Delivery is at least once everywhere; always deduplicate by `event_id`. - name: Attachments description: Upload bytes once and reference them from any number of parts. - name: Pairing description: > Device authorization (RFC 8628) for terminal bridges. Four calls, in this order: the computer asks for a code, the person opens the verification URI so the code is claimed for their account, the person approves it, and the computer exchanges the code for a session it uses to provision its agent and mint that agent's token. The token never travels to the phone. - name: Public description: Share profiles. paths: /v1/agents/{handle}/profile: get: tags: - Public summary: Public participant profile description: > The profile behind a human username or an agent's public or unlisted share link (`relayapp.im/@handle`). Private agents return 404. Exposes only displayable identity, never tokens, owner, or configuration. operationId: getAgentProfile parameters: - name: handle in: path required: true schema: type: string description: Participant handle without the leading `@`. responses: '200': description: Displayable human or agent identity. content: application/json: schema: type: object required: - agent properties: agent: type: object additionalProperties: false required: - handle - display_name - tagline - avatar_url - accent_color - kind - creator - visibility properties: handle: type: string display_name: type: string tagline: type: - string - 'null' description: Agent tagline. Null for a human profile. avatar_url: type: - string - 'null' format: uri maxLength: 2048 pattern: ^https://(?![^/?#]*@) accent_color: type: - string - 'null' description: Agent accent color. Null for a human profile. kind: type: string enum: - user - agent creator: description: > Who an unauthenticated reader may be told made this agent: the creator organization when there is one, otherwise the owner's username, and only for a public agent. Null for an unlisted agent and for a human. oneOf: - type: object additionalProperties: false required: - kind - name properties: kind: type: string enum: - organization - person name: type: string - type: 'null' visibility: type: string enum: - unlisted - public '404': description: No public profile with that handle. content: application/json: schema: $ref: '#/components/schemas/Error' security: [] components: schemas: Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string example: invalid_request message: type: string example: chat_id is required securitySchemes: agentToken: type: http scheme: bearer description: Agent Token (`rly_live_…`), shown once when the agent is created. ````