Inbox · LinkedIn Mentions

Resolve LinkedIn mention

Resolves a LinkedIn mention.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/linkedin-mentions

getLinkedInMentions

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string

Query parameters

Name	Type	Notes
`url`required	string
`displayName`	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/linkedin-mentions?url=https%3A%2F%2Fpozy.ai%2Fmedia%2Fexample-1.jpg" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/linkedin-mentions?url=https%3A%2F%2Fpozy.ai%2Fmedia%2Fexample-1.jpg", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/linkedin-mentions",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "url": "https://pozy.ai/media/example-1.jpg",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

urnstring
typestring
One of person, organization.
displayNamestring
mentionFormatstring
vanityNamestring
warningstring

200 response

{
  "urn": "string",
  "type": "person",
  "displayName": "Acme",
  "mentionFormat": "string",
  "vanityName": "Acme",
  "warning": "string"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.