@archastro/sdk
    Preparing search index...

    Interface Attachment

    A rich attachment associated with a message, such as a file, scraped link, artifact, task, media item, or inline action.

    interface Attachment {
        content_type?: string | null;
        description?: string | null;
        filename?: string | null;
        height?: number | null;
        id: string;
        image_height?: number | null;
        image_source?: ImageSource | null;
        image_url?: string | null;
        image_width?: number | null;
        media_type?: string;
        name?: string | null;
        object?: Record<string, unknown>;
        title?: string | null;
        type: string;
        url?: string | null;
        variants?: MediaVariant[];
        version?: number | null;
        width?: number | null;
    }
    Index

    Properties

    content_type? description? filename? height? id image_height? image_source? image_url? image_width? media_type? name? object? title? type url? variants? version? width?

    Properties

    Optionalcontent_type

    content_type?: string | null

    MIME type of the attached file, e.g. "image/png" or "application/pdf". Present on file, artifact, and media types. null otherwise.

    description?: string | null

    Short description. The page meta-description for scraped_link, the artifact description for artifact, and the task description for task types. null on other types.

    filename?: string | null

    Original filename of the attached file, e.g. "report.pdf". Present on file, artifact, and media types. null otherwise.

    height?: number | null

    Height in pixels of the media item. Present on media type only. null otherwise.

    id: string

    Unique identifier for this attachment within the message.

    image_height?: number | null

    Height in pixels of the scraped preview image. Present on scraped_link type only. null otherwise.

    image_source?: ImageSource | null

    Image source metadata for inline rendering. Present on file, scraped_link, artifact, and media types when the content is an image. null otherwise.

    image_url?: string | null

    URL of the preview image extracted from the scraped page. Present on scraped_link type only. null otherwise.

    image_width?: number | null

    Width in pixels of the scraped preview image. Present on scraped_link type only. null otherwise.

    media_type?: string

    The media category, e.g. "video" or "audio". Present on media type only; omitted otherwise.

    name?: string | null

    Display name of the media item. Present on media type only. null otherwise.

    object?: Record<string, unknown>

    The full embedded object payload. For task type, contains the task record. For action type, contains the action definition. For chart type, contains the chart with its inline spec. Omitted on other types.

    title?: string | null

    Display title. The page title for scraped_link, the artifact name for artifact, and the task title for task types. null on other types.

    type: string

    The attachment type. One of "file", "scraped_link", "artifact", "task", "media", "action", or "chart". Determines which additional fields are present.

    url?: string | null

    URL to access the resource. A signed download URL for file and artifact types; the original URL for scraped_link; a media playback URL for media. null on task and action types.

    variants?: MediaVariant[]

    Array of available encoding variants for the media item (e.g. different resolutions). Present on media type only; omitted otherwise.

    version?: number | null

    Version number of the attached artifact at the time of attachment. Present on artifact type only. null otherwise.

    width?: number | null

    Width in pixels of the media item. Present on media type only. null otherwise.

    Settings

    Member Visibility

    On This Page

    Properties