---
title: "Get OpenGraph info for URL (v3)"
method: POST
path: "/v3/opengraph/info"
tags: ["Open Graph"]
---

# Get OpenGraph info for URL (v3)

`POST /v3/opengraph/info`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/v3/opengraph/info`
- Auth: none declared

OpenGraph info for url, we would like to use mostly opengraph protocol properties: <a href="https://ogp.me/" target="_blank">https://ogp.me/</a>

## Request body

- OpenGraphInfoRequestDto
  - `url` string, required

## Response `200`

- OpenGraphInfoResponseDto
  - `keywords` string
  - `og:site_name` string
  - `og:url` string
  - `og:title` string
  - `og:image` string
  - `og:image:width` string
  - `og:image:height` string
  - `og:description` string
  - `al:ios:app_store_id` string
  - `al:ios:app_name` string
  - `al:ios:url` string
  - `al:android:url` string
  - `al:web:url` string
  - `og:type` string
  - `og:video:url` string
  - `og:video:secure_url` string
  - `og:video:type` string
  - `og:video:width` string
  - `og:video:height` string
  - `al:android:app_name` string
  - `al:android:package` string
  - `og:video:tag` string
  - `fb:app_id` string
  - `twitter:card` string
  - `twitter:site` string
  - `twitter:url` string
  - `twitter:title` string
  - `twitter:description` string
  - `twitter:image` string
  - `twitter:app:name:iphone` string
  - `twitter:app:id:iphone` string
  - `twitter:app:name:ipad` string
  - `twitter:app:id:ipad` string
  - `twitter:app:url:iphone` string
  - `twitter:app:url:ipad` string
  - `twitter:app:name:googleplay` string
  - `twitter:app:id:googleplay` string
  - `twitter:app:url:googleplay` string
  - `twitter:player` string
  - `twitter:player:width` string
  - `twitter:player:height` string
  - `referrer` string
  - `favicon` string

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)