aVenture APIMedia

Import entity logo from website

View as Markdown

Previews or imports a logo discovered from the entity’s first-party website. Use exactly one target selector: id, slug, or canonical website url; url is not a direct image, social card, banner, or screenshot.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

Query parameters

idstringOptionalformat: "uuid"

Exact entity UUID whose logo slot should be imported. CLI flag: —media-id. Mutually exclusive with slug/—media-slug and url/—url.

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Exact entity slug whose logo slot should be imported. CLI flag: —media-slug. Mutually exclusive with id/—media-id and url/—url.

urlstringOptionalformat: "uri"

Canonical first-party company website URL to inspect for logo candidates; do not pass a direct image, OpenGraph card, social card, banner, or screenshot URL. Mutually exclusive with id/—media-id and slug/—media-slug.

permitWidebooleanOptionalDefaults to false

Fallback that permits a wide (non-square) logo into the square logo slot, used only after confirming no square or near-square logo exists. Default false rejects wide wordmark/banner candidates. CLI flag: —permit-wide. Blank or invisible images are always rejected regardless of this flag.

previewbooleanOptionalDefaults to false
Fetch and return the selected source image URL without writing
sourceTypeenumRequired
Write provenance source type.
sourceDetailstringRequired
Source detail or reviewer reference for the write.
sourceProviderstringOptional

Provider name for provider-native IDs or slugs.

sourceProviderIdstringOptional

Provider-native source ID.

sourceProviderSlugstringOptional

Provider-native source slug.

actorTypeenumOptional

Actor type; inferred as agent when agentChassis and agentModel are supplied, or as employee from an authenticated user JWT session.

Allowed values:
agentChassisstringOptional

Agent chassis token for agent-authored writes.

agentModelstringOptional

Agent model id for agent-authored writes.

Response

OK
sourceImageUrlstringformat: "uri"
External image URL selected by the discovery process after redirects.
candidateCountinteger or nullOptional
Candidate count considered before selection
confidencestring or nullOptional
Confidence assigned to the winning candidate
mediaobject or nullOptional

Managed Cloudflare R2/images-v2 media asset after import; absent for preview. When news id/slug is omitted, use media.path as newsImageThumbnail on create.

winningSignalstring or nullOptional

Winning discovery signal such as JSON_LD_IMAGE or OPEN_GRAPH

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error