{ "openapi": "3.1.0", "info": { "title": "Open Media API", "version": "1.0.0", "description": "Post everywhere. Message everyone. One app. Everything Open Media offers to people it offers to programs and AI agents. Public data needs no account or key.", "x-api-lifecycle": { "versioning": "Path-versioned (/v1). Fields may be added; nothing is removed or changed incompatibly without at least 90 days’ notice, a Deprecation header and a Sunset header.", "documentation": "https://openmedia.site/docs#versioning-and-deprecation" }, "x-rate-limits": { "policy": "About 120 requests per minute per client IP on public and agent routes.", "headers": [ "RateLimit-Policy", "Retry-After" ] }, "x-sandbox": { "description": "Payments run in Stripe test mode and on Base Sepolia until live payments are approved; GET /v1/me/payments/setup reports the mode. For a private sandbox, run the open-source stack locally with `npm run local`.", "documentation": "https://openmedia.site/developers" } }, "servers": [ { "url": "https://openmedia.site", "description": "Open Media API" } ], "paths": { "/v1/posts": { "get": { "summary": "List public posts, newest first", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from pagination.nextCursor." }, { "name": "media", "in": "query", "schema": { "type": "string", "enum": [ "video" ] }, "description": "Only posts with a video." } ], "responses": { "200": { "description": "A page of posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ], "format": "uri" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getPosts", "description": "List public posts, newest first" } }, "/v1/posts/{id}": { "get": { "summary": "Get one public post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A post", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getPostsById", "description": "Get one public post" } }, "/v1/profiles/{handle}": { "get": { "summary": "Get a public profile", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Profile" } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getProfilesByHandle", "description": "Get a public profile" } }, "/v1/profiles/{handle}/posts": { "get": { "summary": "List a profile's public posts, newest first", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from pagination.nextCursor." }, { "name": "media", "in": "query", "schema": { "type": "string", "enum": [ "video" ] }, "description": "Only posts with a video." } ], "responses": { "200": { "description": "A page of posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ], "format": "uri" } } } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getProfilesByHandlePosts", "description": "List a profile's public posts, newest first" } }, "/v1/feed": { "get": { "summary": "The mixed feed across Open Media and open networks, with “Why this?” reasons", "parameters": [ { "name": "sources", "in": "query", "schema": { "type": "string" }, "description": "Comma-separated: open-media, farcaster, lens, hive, deso. Default: all." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "feed", "clips" ] } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "raw", "relevant" ] } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "nextCursor from a previous page." } ], "responses": { "200": { "description": "A page of posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentPost" } }, "unavailable": { "type": "array", "items": { "type": "string" } }, "nextCursor": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getFeed", "description": "The mixed feed across Open Media and open networks, with “Why this?” reasons" } }, "/v1/search": { "get": { "summary": "Plain-language search across public posts on every network, plus matching settings", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Results with what was understood and how each network was searched", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getSearch", "description": "Plain-language search across public posts on every network, plus matching settings" } }, "/v1/networks": { "get": { "summary": "Every network and connector, with what works today", "responses": { "200": { "description": "Networks and capabilities", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getNetworks", "description": "Every network and connector, with what works today" } }, "/v1/settings": { "get": { "summary": "The searchable settings index", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Matching settings", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getSettings", "description": "The searchable settings index" } }, "/v1/events/upcoming": { "get": { "summary": "Upcoming public events (Luma, Meetup, Eventbrite) in the San Francisco Bay Area, de-duplicated across platforms, with official registration links", "parameters": [ { "name": "area", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 14, "default": 7 } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } } ], "responses": { "200": { "description": "Events, soonest first, with each provider’s status", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getEventsUpcoming", "description": "Upcoming public events (Luma, Meetup, Eventbrite) in the San Francisco Bay Area, de-duplicated across platforms, with official registration links" } }, "/v1/people/{network}/{handle}": { "get": { "summary": "One person’s public posts in one timeline (Open Media profile plus the accounts they listed, or one open-network account)", "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "open-media", "farcaster", "lens", "hive", "deso" ] } }, { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The person and their posts, newest first", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getPeopleByNetworkByHandle", "description": "One person’s public posts in one timeline (Open Media profile plus the accounts they listed, or one open-network account)" } }, "/v1/about": { "get": { "summary": "Mission, principles, promises, roadmap and honest status", "responses": { "200": { "description": "About Open Media", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getAbout", "description": "Mission, principles, promises, roadmap and honest status" } }, "/v1/me": { "get": { "summary": "Your profile", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMe", "description": "Your profile" }, "delete": { "summary": "Delete your account (irreversible)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "confirmation" ], "properties": { "confirmation": { "type": "string", "const": "delete my account" } } } } } }, "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMe", "description": "Delete your account (irreversible)" } }, "/v1/me/posts": { "post": { "summary": "Publish a public post", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "maxLength": 2000 } } } } } }, "responses": { "201": { "description": "The new post", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Post" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePosts", "description": "Publish a public post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Retrying with the same key returns the first result instead of creating a second one." } ] } }, "/v1/me/posts/{id}": { "delete": { "summary": "Delete one of your posts", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMePostsById", "description": "Delete one of your posts" } }, "/v1/posts/{id}/report": { "post": { "summary": "Report a post for review", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "enum": [ "spam", "harassment", "other" ] }, "details": { "type": "string", "maxLength": 1000 } } } } } }, "responses": { "200": { "description": "Reported", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postPostsByIdReport", "description": "Report a post for review" } }, "/v1/me/conversations": { "get": { "summary": "Your conversations with recent messages", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Conversations", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeConversations", "description": "Your conversations with recent messages" }, "post": { "summary": "Start a conversation with a handle", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "handle" ], "properties": { "handle": { "type": "string", "maxLength": 24 } } } } } }, "responses": { "201": { "description": "The conversation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeConversations", "description": "Start a conversation with a handle" } }, "/v1/me/conversations/{id}/messages": { "post": { "summary": "Send a message", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "maxLength": 8000 } } } } } }, "responses": { "201": { "description": "Sent", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeConversationsByIdMessages", "description": "Send a message" } }, "/v1/me/export": { "get": { "summary": "Export a readable copy of your data", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Your data", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeExport", "description": "Export a readable copy of your data" } }, "/v1/me/email": { "get": { "summary": "Your stored email, newest first", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } } ], "responses": { "200": { "description": "Email", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeEmail", "description": "Your stored email, newest first" } }, "/v1/me/contacts": { "get": { "summary": "Your contacts (private; stored encrypted)", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Your contact cards", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeContacts", "description": "Your contacts (private; stored encrypted)" }, "put": { "summary": "Create or replace contact cards by id (up to 500)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 500, "items": { "type": "object", "required": [ "id", "name", "phones", "emails", "links", "rejected", "nicknames", "notes" ], "properties": { "id": { "type": "string", "format": "uuid" }, "source": { "type": "string", "enum": [ "device", "manual" ] }, "name": { "type": "string" }, "nicknames": { "type": "array", "items": { "type": "string" } }, "phones": { "type": "array", "items": { "type": "string" } }, "emails": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "string" }, "links": { "type": "array", "items": { "type": "object" } }, "rejected": { "type": "array", "items": { "type": "string" } }, "updatedAt": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMeContacts", "description": "Create or replace contact cards by id (up to 500)" } }, "/v1/me/contacts/{id}": { "delete": { "summary": "Delete one of your contact cards", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMeContactsById", "description": "Delete one of your contact cards" } }, "/v1/me/linked-accounts": { "put": { "summary": "Set the open-network accounts shown on your public profile (public, up to 8)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 8, "items": { "type": "object", "required": [ "network", "handle" ], "properties": { "network": { "type": "string", "enum": [ "farcaster", "lens", "hive", "deso" ] }, "handle": { "type": "string", "pattern": "^[A-Za-z0-9._-]{1,64}$" } } } } } } }, "responses": { "200": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMeLinkedAccounts", "description": "Set the open-network accounts shown on your public profile (public, up to 8)" } }, "/v1/me/listings": { "post": { "summary": "Offer a product or service as a public post", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "kind", "title" ], "properties": { "kind": { "type": "string", "enum": [ "product", "service" ] }, "title": { "type": "string", "maxLength": 120 }, "price": { "type": "string", "description": "e.g. \"25.50\"; omit for ask-for-price" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "location": { "type": "string", "maxLength": 120 }, "remote": { "type": "boolean" }, "text": { "type": "string" } } } } } }, "responses": { "201": { "description": "The post with its listing", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeListings", "description": "Offer a product or service as a public post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Retrying with the same key returns the first result instead of creating a second one." } ] } }, "/v1/me/listings/{postId}": { "patch": { "summary": "Change a listing’s availability, price or place", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "availability": { "type": "string", "enum": [ "available", "limited", "sold_out" ] }, "priceMinor": { "type": [ "integer", "null" ] }, "location": { "type": [ "string", "null" ] }, "remote": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "The listing", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "patchMeListingsByPostId", "description": "Change a listing’s availability, price or place" } }, "/v1/me/listings/{postId}/rating": { "put": { "summary": "Rate a listing 1–5 stars (verified people who show their legal name only)", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "stars" ], "properties": { "stars": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } }, "responses": { "200": { "description": "The listing’s rating summary", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMeListingsByPostIdRating", "description": "Rate a listing 1–5 stars (verified people who show their legal name only)" }, "delete": { "summary": "Withdraw your rating", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The listing’s rating summary", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMeListingsByPostIdRating", "description": "Withdraw your rating" } }, "/v1/me/identity": { "get": { "summary": "Your identity tier, tick, shown name, privacy and verification status", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Your identity", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeIdentity", "description": "Your identity tier, tick, shown name, privacy and verification status" }, "put": { "summary": "Choose the name others see and whether your account is private", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nameDisclosure": { "type": "string", "enum": [ "handle_only", "declared", "verified_legal" ] }, "visibility": { "type": "string", "enum": [ "public", "private" ] } } } } } }, "responses": { "200": { "description": "Updated identity", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMeIdentity", "description": "Choose the name others see and whether your account is private" } }, "/v1/me/verification": { "post": { "summary": "Start identity verification with Stripe Identity (returns a link to open)", "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Verification link", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeVerification", "description": "Start identity verification with Stripe Identity (returns a link to open)" } }, "/v1/me/follows": { "get": { "summary": "Who you follow, your followers and requests waiting for you", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Follows", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeFollows", "description": "Who you follow, your followers and requests waiting for you" }, "post": { "summary": "Follow someone (private accounts get a request)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "handle" ], "properties": { "handle": { "type": "string" } } } } } }, "responses": { "201": { "description": "Following or requested", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeFollows", "description": "Follow someone (private accounts get a request)" } }, "/v1/me/follows/{handle}": { "delete": { "summary": "Unfollow, or withdraw a request", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMeFollowsByHandle", "description": "Unfollow, or withdraw a request" } }, "/v1/me/follow-requests/{id}": { "post": { "summary": "Accept or decline a follow request", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "accept" ], "properties": { "accept": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Done", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeFollowRequestsById", "description": "Accept or decline a follow request" } }, "/v1/me/followers/{id}": { "delete": { "summary": "Remove a follower", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Done", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMeFollowersById", "description": "Remove a follower" } }, "/v1/verification/stripe/webhook": { "post": { "summary": "Stripe Identity webhook (signed by Stripe; not for clients)", "responses": { "200": { "description": "Received", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postVerificationStripeWebhook", "description": "Stripe Identity webhook (signed by Stripe; not for clients)" } }, "/v1/payments/stripe/webhook": { "post": { "summary": "Stripe payments and Connect webhook (signed by Stripe; not for clients). Each event is re-read from Stripe before it changes a payment.", "responses": { "200": { "description": "Received", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postPaymentsStripeWebhook", "description": "Stripe payments and Connect webhook (signed by Stripe; not for clients). Each event is re-read from Stripe before it changes a payment." } }, "/v1/me/payments/setup": { "get": { "summary": "Your card payouts, linked wallets, tips setting, fees and what this server supports", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Payment setup", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMePaymentsSetup", "description": "Your card payouts, linked wallets, tips setting, fees and what this server supports" } }, "/v1/me/payments/payouts": { "post": { "summary": "Start or continue Stripe payouts setup (returns a link to open)", "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Stripe link", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePaymentsPayouts", "description": "Start or continue Stripe payouts setup (returns a link to open)" } }, "/v1/me/payments/payouts/refresh": { "post": { "summary": "Re-read your Stripe account status", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Payment setup", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePaymentsPayoutsRefresh", "description": "Re-read your Stripe account status" } }, "/v1/me/ondc": { "get": { "summary": "Your ONDC store (ADR 0015), or null", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "ONDC store", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeOndc", "description": "Your ONDC store (ADR 0015), or null" }, "put": { "summary": "Save your ONDC store. Turning it on needs every detail and the declaration; your phone, email and address are then shown to ONDC buyers. Orders through ONDC are not accepted yet.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" }, "storeName": { "type": "string" }, "category": { "type": "string", "enum": [ "ONDC:RET12", "ONDC:RET13", "ONDC:RET14", "ONDC:RET15", "ONDC:RET16" ] }, "building": { "type": "string" }, "locality": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "areaCode": { "type": "string", "pattern": "^[1-9][0-9]{5}$" }, "stdCode": { "type": "string", "examples": [ "080" ] }, "gps": { "type": "string", "examples": [ "12.9716,77.5946" ] }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email" }, "timeToShip": { "type": "string", "enum": [ "PT24H", "P2D", "P3D", "P5D", "P7D" ] }, "returnable": { "type": "boolean" }, "returnWindow": { "type": "string", "enum": [ "P7D", "P10D", "P15D", "P30D" ] }, "cancellable": { "type": "boolean" }, "declarationAccepted": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "ONDC store", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMeOndc", "description": "Save your ONDC store. Turning it on needs every detail and the declaration; your phone, email and address are then shown to ONDC buyers. Orders through ONDC are not accepted yet." } }, "/v1/me/payments/tips": { "put": { "summary": "Turn tips on or off", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Tips setting", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putMePaymentsTips", "description": "Turn tips on or off" } }, "/v1/me/payments": { "get": { "summary": "Payments you sent and received", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "Payments", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMePayments", "description": "Payments you sent and received" }, "post": { "summary": "Start a payment for a listing, a tip or a paid post. The amount and recipient come from Open Media, except a tip’s amount. Card returns checkoutUrl; USDC returns the transfer for your wallet. Nothing is paid until Stripe or the network confirms it.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "contextType", "contextId", "rail" ], "properties": { "contextType": { "type": "string", "enum": [ "listing", "tip", "paid_post" ] }, "contextId": { "type": "string", "format": "uuid" }, "rail": { "type": "string", "enum": [ "card", "onchain" ] }, "chain": { "type": "string", "enum": [ "base-sepolia", "base" ] }, "amountMinor": { "type": "integer", "minimum": 100, "maximum": 50000, "description": "Tips only, in cents" }, "idempotencyKey": { "type": "string", "format": "uuid" } } } } } }, "responses": { "201": { "description": "Payment started", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePayments", "description": "Start a payment for a listing, a tip or a paid post. The amount and recipient come from Open Media, except a tip’s amount. Card returns checkoutUrl; USDC returns the transfer for your wallet. Nothing is paid until Stripe or the network confirms it.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Retrying with the same key returns the first result instead of creating a second one." } ] } }, "/v1/me/payments/{id}": { "get": { "summary": "One of your payments", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Payment", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMePaymentsById", "description": "One of your payments" } }, "/v1/me/payments/{id}/transaction": { "post": { "summary": "Report the USDC transaction that paid; Open Media checks it on the network", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "txHash" ], "properties": { "txHash": { "type": "string", "maxLength": 66 } } } } } }, "responses": { "200": { "description": "Payment and check result", "content": { "application/json": { "schema": { "type": "object" } } } }, "202": { "description": "Accepted: the network has not settled the payment yet. Poll the Location (or POST to job.check) after Retry-After seconds.", "headers": { "Location": { "schema": { "type": "string", "format": "uri" }, "description": "The payment to poll" }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "payment", "job" ], "properties": { "payment": { "type": "object" }, "detail": { "type": "string" }, "job": { "type": "object", "required": [ "id", "status", "poll" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "running" ] }, "poll": { "type": "string", "format": "uri" }, "check": { "type": "string", "format": "uri" }, "retryAfterSeconds": { "type": "integer" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePaymentsByIdTransaction", "description": "Report the USDC transaction that paid; Open Media checks it on the network" } }, "/v1/me/payments/{id}/check": { "post": { "summary": "Check a payment again", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Payment and check result", "content": { "application/json": { "schema": { "type": "object" } } } }, "202": { "description": "Accepted: the network has not settled the payment yet. Poll the Location (or POST to job.check) after Retry-After seconds.", "headers": { "Location": { "schema": { "type": "string", "format": "uri" }, "description": "The payment to poll" }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "payment", "job" ], "properties": { "payment": { "type": "object" }, "detail": { "type": "string" }, "job": { "type": "object", "required": [ "id", "status", "poll" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "running" ] }, "poll": { "type": "string", "format": "uri" }, "check": { "type": "string", "format": "uri" }, "retryAfterSeconds": { "type": "integer" } } } } } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePaymentsByIdCheck", "description": "Check a payment again" } }, "/v1/me/wallets": { "post": { "summary": "Link a wallet with a signature of Open Media’s message from that wallet (at most 10 minutes old)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "signature" ], "properties": { "message": { "type": "string" }, "signature": { "type": "string" } } } } } }, "responses": { "201": { "description": "Linked wallet", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeWallets", "description": "Link a wallet with a signature of Open Media’s message from that wallet (at most 10 minutes old)" } }, "/v1/me/wallets/{id}": { "delete": { "summary": "Unlink a wallet", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Removed", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMeWalletsById", "description": "Unlink a wallet" } }, "/v1/me/listings/{postId}/payment-options": { "get": { "summary": "How a listing can be paid for: card, USDC networks, price and fee", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Options", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMeListingsByPostIdPaymentOptions", "description": "How a listing can be paid for: card, USDC networks, price and fee" } }, "/v1/me/posts/{id}/payment-options": { "get": { "summary": "How a post can be paid for: tips, unlocking, card, USDC networks and fees", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Options", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMePostsByIdPaymentOptions", "description": "How a post can be paid for: tips, unlocking, card, USDC networks and fees" } }, "/v1/me/posts/{id}/paid": { "get": { "summary": "The paid part of a post, if you wrote it or paid for it; otherwise its price only", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Paid part", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMePostsByIdPaid", "description": "The paid part of a post, if you wrote it or paid for it; otherwise its price only" } }, "/v1/me/paid-posts": { "post": { "summary": "Publish a post with a free preview and a paid part", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "preview", "paidText", "priceMinor" ], "properties": { "preview": { "type": "string", "maxLength": 2000 }, "paidText": { "type": "string", "maxLength": 10000 }, "priceMinor": { "type": "integer", "minimum": 50 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } } } } } }, "responses": { "201": { "description": "Published", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMePaidPosts", "description": "Publish a post with a free preview and a paid part", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Retrying with the same key returns the first result instead of creating a second one." } ] } }, "/v1/me/blocks": { "post": { "summary": "Block or unblock someone", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "handle" ], "properties": { "handle": { "type": "string" }, "blocked": { "type": "boolean", "default": true } } } } } }, "responses": { "200": { "description": "Done", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeBlocks", "description": "Block or unblock someone" } }, "/v1/me/conversations/{id}/report": { "post": { "summary": "Report unwanted contact", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "handle" ], "properties": { "handle": { "type": "string" }, "messageId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "200": { "description": "Reported", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMeConversationsByIdReport", "description": "Report unwanted contact" } }, "/v1/mail-accounts": { "get": { "summary": "Your connected mailboxes", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Mailboxes", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getMailAccounts", "description": "Your connected mailboxes" }, "post": { "summary": "Connect a mailbox (tested before it is saved; the password is stored encrypted)", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "protocol", "host", "port", "secure", "username", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "protocol": { "type": "string", "enum": [ "imap", "pop3" ] }, "host": { "type": "string" }, "port": { "type": "integer" }, "secure": { "type": "boolean", "const": true }, "username": { "type": "string" }, "password": { "type": "string", "description": "An app password." }, "smtp": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "security": { "type": "string", "enum": [ "tls", "starttls" ] } } } } } } } }, "responses": { "201": { "description": "Connected", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMailAccounts", "description": "Connect a mailbox (tested before it is saved; the password is stored encrypted)" } }, "/v1/mail-accounts/{id}": { "delete": { "summary": "Remove a mailbox and its stored mail", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removed", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteMailAccountsById", "description": "Remove a mailbox and its stored mail" } }, "/v1/mail-accounts/{id}/sync": { "post": { "summary": "Fetch new mail", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Synced messages", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMailAccountsByIdSync", "description": "Fetch new mail" } }, "/v1/mail-accounts/{id}/send": { "post": { "summary": "Send an email", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "to", "subject", "text" ], "properties": { "to": { "type": "array", "items": { "type": "string", "format": "email" }, "maxItems": 10 }, "subject": { "type": "string" }, "text": { "type": "string" }, "inReplyTo": { "type": "string" } } } } } }, "responses": { "201": { "description": "Sent", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postMailAccountsByIdSend", "description": "Send an email" } }, "/v1/bridges": { "get": { "summary": "Chat networks this server bridges, and your connections", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Networks", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getBridges", "description": "Chat networks this server bridges, and your connections" } }, "/v1/bridges/conversations": { "get": { "summary": "Your bridged chats", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Chats", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getBridgesConversations", "description": "Your bridged chats" } }, "/v1/bridges/rooms/{id}/messages": { "post": { "summary": "Reply in a bridged chat", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "maxLength": 8000 } } } } } }, "responses": { "201": { "description": "Sent", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postBridgesRoomsByIdMessages", "description": "Reply in a bridged chat" } }, "/v1/bridges/{network}/flows": { "get": { "summary": "Sign-in options for a chat network", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Options", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getBridgesByNetworkFlows", "description": "Sign-in options for a chat network" } }, "/v1/bridges/{network}/login/start": { "post": { "summary": "Start connecting a chat network", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "flow" ], "properties": { "flow": { "type": "string", "maxLength": 64 } } } } } }, "responses": { "200": { "description": "The first sign-in step", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postBridgesByNetworkLoginStart", "description": "Start connecting a chat network" } }, "/v1/bridges/{network}/login/step": { "post": { "summary": "Continue a sign-in step", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The next step, or complete", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postBridgesByNetworkLoginStep", "description": "Continue a sign-in step" } }, "/v1/bridges/{network}/login/cancel": { "post": { "summary": "Cancel a sign-in", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancelled", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postBridgesByNetworkLoginCancel", "description": "Cancel a sign-in" } }, "/v1/bridges/{network}/logout": { "post": { "summary": "Disconnect a chat network", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Disconnected", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postBridgesByNetworkLogout", "description": "Disconnect a chat network" } }, "/v1/cross-posting/status": { "get": { "summary": "Which networks this server helps cross-post to", "responses": { "200": { "description": "Status", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. Wait for Retry-After seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getCrossPostingStatus", "description": "Which networks this server helps cross-post to" } }, "/v1/search/assist": { "post": { "summary": "AI summary of public posts you pass in, with citations", "responses": { "200": { "description": "Summary", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postSearchAssist", "description": "AI summary of public posts you pass in, with citations" } } }, "components": { "schemas": { "Post": { "type": "object", "required": [ "id", "type", "text", "createdAt", "url", "video", "author" ], "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "post" ] }, "text": { "type": "string", "maxLength": 2000, "description": "May be empty when the post is a video." }, "createdAt": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" }, "video": { "type": [ "object", "null" ], "description": "One short video attached to the post, or null.", "required": [ "url", "posterUrl", "streaming", "contentType", "durationSeconds", "width", "height", "sha256" ], "properties": { "url": { "type": "string", "format": "uri" }, "posterUrl": { "type": [ "string", "null" ], "format": "uri" }, "streaming": { "type": "string", "enum": [ "progressive", "hls" ] }, "contentType": { "type": "string", "enum": [ "video/mp4", "video/quicktime", "video/webm" ] }, "durationSeconds": { "type": "number", "maximum": 180 }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "SHA-256 of the video file as uploaded." } } }, "author": { "type": "object", "required": [ "handle", "displayName", "url" ], "properties": { "handle": { "type": "string" }, "displayName": { "type": "string" }, "avatarUrl": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": "string", "format": "uri" } } } } }, "Profile": { "type": "object", "required": [ "type", "handle", "displayName", "bio", "joinedAt", "postCount", "url", "postsUrl" ], "properties": { "type": { "type": "string", "enum": [ "profile" ] }, "handle": { "type": "string" }, "displayName": { "type": "string" }, "bio": { "type": "string" }, "avatarUrl": { "type": [ "string", "null" ], "format": "uri" }, "joinedAt": { "type": "string", "format": "date-time" }, "postCount": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "postsUrl": { "type": "string", "format": "uri" } } }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "AgentPost": { "type": "object", "properties": { "id": { "type": "string" }, "network": { "type": "string", "enum": [ "open-media", "farcaster", "lens", "hive", "deso" ] }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "handle": { "type": "string" }, "avatarUrl": { "type": [ "string", "null" ] } } }, "title": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "url": { "type": [ "string", "null" ], "format": "uri" }, "media": { "type": "array", "items": { "type": "object" } }, "engagement": { "type": [ "object", "null" ] }, "why": { "type": "object", "properties": { "used": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "array", "items": { "type": "string" } }, "notUsed": { "type": "array", "items": { "type": "string" } } } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "The person’s Open Media access token (Settings → Developers and agents). Expires after about an hour." } } }, "x-mcp-servers": [ { "path": "/open/mcp", "auth": "none", "description": "Public tools: feed, search, posts, profiles, person timelines, upcoming events, networks, settings and the mission.", "url": "https://openmedia.site/open/mcp" }, { "path": "/me/mcp", "auth": "Open Media access token", "description": "Your account: posts, listings, payments (each one confirmed by you first), tips and paid posts, messages, contacts, linked accounts, identity and privacy, follows, email, chat networks, cross-posting status, blocking, reports, export and account deletion.", "url": "https://openmedia.site/me/mcp" }, { "path": "/mcp", "auth": "OAuth 2.1", "description": "Open Media Events: find events, check your calendar and plan your week.", "url": "https://openmedia.site/mcp" } ], "externalDocs": { "description": "API documentation", "url": "https://openmedia.site/docs" } }