Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview
On this page

document_get

Fetch one brand document — images come back as an image the assistant can actually look at.

Fetches one document. The difference from document_list is what you get back for an image: the picture itself, not just a link to it.

That’s the point of this tool. An assistant that can see your logo can tell you whether a headline sits well beside it; one holding a URL can only take your word for it.

Input

Field Type Required Description
document_id string yes The id of the document to fetch.

Output

Always the metadata — { id, name, filename, mimeType, sizeBytes, url }.

Images under 1 MB additionally come back as an image the assistant can view. Everything else — PDFs, larger images — returns metadata and the URL alone.

Example

“Does this headline work with our logo?”

document_get({ document_id: 'doc_…' });
// → metadata, plus the logo itself for the assistant to look at

Requires the brand:read scope.

Was this page helpful?