> ## Documentation Index
> Fetch the complete documentation index at: https://www.posted.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview a link

> Reads the first link's Open Graph or page metadata for a composer card. Only public HTTP destinations are fetched. Returns null when metadata is unavailable. Images are bounded, re-encoded JPEG data in base64; no remote image URL is exposed.

Read access: a read-enabled personal or team REST API key, or a signed-in user. OAuth clients use the corresponding MCP tool through /mcp.

Reads the first link's Open Graph or page metadata for a composer card. Only public HTTP destinations are fetched. Returns null when metadata is unavailable. Images are bounded, re-encoded JPEG data in base64; no remote image URL is exposed.

[Request conventions](/api-reference/overview) · [API keys](/api-keys) · [MCP connections](/mcp-connections)


## OpenAPI

````yaml api-reference/openapi.json GET /api/link-preview
openapi: 3.1.0
info:
  title: Posted HTTP API
  version: 0.2.3
  description: >-
    All registered application, account, OAuth, MCP transport and health
    endpoints. Publishing and draft request schemas come from the shared runtime
    validators. Replace the example server with your installation. Documentation
    uses simple request examples and does not execute live publishing requests.
servers:
  - url: https://posted-api.example.com
security: []
paths:
  /api/link-preview:
    get:
      tags:
        - Media
      summary: Preview a link
      description: >-
        Reads the first link's Open Graph or page metadata for a composer card.
        Only public HTTP destinations are fetched. Returns null when metadata is
        unavailable. Images are bounded, re-encoded JPEG data in base64; no
        remote image URL is exposed.


        Read access: a read-enabled personal or team REST API key, or a
        signed-in user. OAuth clients use the corresponding MCP tool through
        /mcp.
      operationId: get_api_link_preview
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
            maxLength: 2048
            format: uri
          description: uri
      responses:
        '200':
          description: >-
            Successful response. Examples are illustrative; field values vary by
            record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  preview:
                    type: object
                    properties:
                      url:
                        type: string
                      title:
                        type: string
                      description:
                        type: string
                      siteName:
                        type: string
                    additionalProperties: true
                additionalProperties: true
              example:
                preview:
                  url: https://example.com/story
                  title: A story
                  description: Read the full story.
                  siteName: Example
        default:
          description: >-
            Request failure. Inspect code, message and requestId; respect
            Retry-After on HTTP 429.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal or team Posted REST API key
    sessionCookie:
      type: apiKey
      in: cookie
      name: posted_session
      description: >-
        Signed-in human browser session; mutation requests also need the exact
        UI Origin

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.