Email, calendar & files · Files

Get an anyone-with-the-link share link

Fetches an anyone-with-the-link share link.

GEThttps://api.pozy.ai/v1/files/{fileId}/share-link
getFileShareLink

Guides: Files, Email, calendar & files, Google Workspace

Request

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

Path parameters

NameTypeNotes
fileIdrequiredstring

Query parameters

NameTypeNotes
accountIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/files/6035bf6bd3aac3067c336c50/share-link?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • dataobject
    • urlstring (URL)required
    • scopestringrequired

      One of anyone_with_link.

200 response
{
  "data": {
    "url": "https://pozy.ai/media/example-1.jpg",
    "scope": "anyone_with_link"
  }
}

Errors

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

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Files