Skip to content

BRAPI-1553: Add response metadata to Browser Run types #7002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BernardoPe wants to merge 2 commits into
base: main
Choose a base branch
from
Open

BRAPI-1553: Add response metadata to Browser Run types #7002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4467e4c
BRAPI-1553: Add response metadata to Browser Run types
BernardoPe Aug 14, 2026
e2cee0f
Merge branch 'main' into bpereira/brapi-1553-browser-run-response-meta
BernardoPe Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions types/defines/browser-run.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,11 +258,26 @@ type BrowserRunJsonOptions = BrowserRunCommonOptions &
type BrowserRunContentOptions = BrowserRunCommonOptions;
type BrowserRunMarkdownOptions = BrowserRunCommonOptions;

type BrowserRunRedirectHop = {
/** URL that returned the redirect. */
url: string;
/** HTTP status of the redirect. */
status: number;
/** Redirect response headers, including `location`. */
headers: Record<string, string>;
};

type BrowserRunResponseMeta = {
/** HTTP status code of the rendered page */
status: number;
/** Page title */
title: string;
/** Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted. */
headers?: Record<string, string>;
/** URL that served the response, after any redirects the browser followed. */
finalUrl?: string;
/** HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read. */
redirectChain?: BrowserRunRedirectHop[];
};

/** Success response for `content` action. */
Expand All @@ -278,6 +293,7 @@ type BrowserRunLinksSuccessResponse = {
success: true;
/** Extracted links */
result: string[];
meta: BrowserRunResponseMeta;
};

/** Success response for `scrape` action. */
Expand Down Expand Up @@ -309,6 +325,7 @@ type BrowserRunScrapeSuccessResponse = {
}>;
}>;
}>;
meta: BrowserRunResponseMeta;
};

/** Success response for `snapshot` action. */
Expand All @@ -328,13 +345,15 @@ type BrowserRunJsonSuccessResponse = {
success: true;
/** JSON data extracted from the page using an AI model */
result: Record<string, unknown>;
meta: BrowserRunResponseMeta;
};

/** Success response for `markdown` action. */
type BrowserRunMarkdownSuccessResponse = {
success: true;
/** Extracted markdown content */
result: string;
meta: BrowserRunResponseMeta;
};

/** Error response for BrowserRun actions. */
Expand Down
18 changes: 18 additions & 0 deletions types/generated-snapshot/experimental/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12745,11 +12745,25 @@ type BrowserRunJsonOptions = BrowserRunCommonOptions &
);
type BrowserRunContentOptions = BrowserRunCommonOptions;
type BrowserRunMarkdownOptions = BrowserRunCommonOptions;
type BrowserRunRedirectHop = {
/** URL that returned the redirect. */
url: string;
/** HTTP status of the redirect. */
status: number;
/** Redirect response headers, including `location`. */
headers: Record<string, string>;
};
type BrowserRunResponseMeta = {
/** HTTP status code of the rendered page */
status: number;
/** Page title */
title: string;
/** Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted. */
headers?: Record<string, string>;
/** URL that served the response, after any redirects the browser followed. */
finalUrl?: string;
/** HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read. */
redirectChain?: BrowserRunRedirectHop[];
};
/** Success response for `content` action. */
type BrowserRunContentSuccessResponse = {
Expand All @@ -12763,6 +12777,7 @@ type BrowserRunLinksSuccessResponse = {
success: true;
/** Extracted links */
result: string[];
meta: BrowserRunResponseMeta;
};
/** Success response for `scrape` action. */
type BrowserRunScrapeSuccessResponse = {
Expand Down Expand Up @@ -12793,6 +12808,7 @@ type BrowserRunScrapeSuccessResponse = {
}>;
}>;
}>;
meta: BrowserRunResponseMeta;
};
/** Success response for `snapshot` action. */
type BrowserRunSnapshotSuccessResponse = {
Expand All @@ -12810,12 +12826,14 @@ type BrowserRunJsonSuccessResponse = {
success: true;
/** JSON data extracted from the page using an AI model */
result: Record<string, unknown>;
meta: BrowserRunResponseMeta;
};
/** Success response for `markdown` action. */
type BrowserRunMarkdownSuccessResponse = {
success: true;
/** Extracted markdown content */
result: string;
meta: BrowserRunResponseMeta;
};
/** Error response for BrowserRun actions. */
type BrowserRunErrorResponse = {
Expand Down
18 changes: 18 additions & 0 deletions types/generated-snapshot/experimental/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12759,11 +12759,25 @@ export type BrowserRunJsonOptions = BrowserRunCommonOptions &
);
export type BrowserRunContentOptions = BrowserRunCommonOptions;
export type BrowserRunMarkdownOptions = BrowserRunCommonOptions;
export type BrowserRunRedirectHop = {
/** URL that returned the redirect. */
url: string;
/** HTTP status of the redirect. */
status: number;
/** Redirect response headers, including `location`. */
headers: Record<string, string>;
};
export type BrowserRunResponseMeta = {
/** HTTP status code of the rendered page */
status: number;
/** Page title */
title: string;
/** Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted. */
headers?: Record<string, string>;
/** URL that served the response, after any redirects the browser followed. */
finalUrl?: string;
/** HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read. */
redirectChain?: BrowserRunRedirectHop[];
};
/** Success response for `content` action. */
export type BrowserRunContentSuccessResponse = {
Expand All @@ -12777,6 +12791,7 @@ export type BrowserRunLinksSuccessResponse = {
success: true;
/** Extracted links */
result: string[];
meta: BrowserRunResponseMeta;
};
/** Success response for `scrape` action. */
export type BrowserRunScrapeSuccessResponse = {
Expand Down Expand Up @@ -12807,6 +12822,7 @@ export type BrowserRunScrapeSuccessResponse = {
}>;
}>;
}>;
meta: BrowserRunResponseMeta;
};
/** Success response for `snapshot` action. */
export type BrowserRunSnapshotSuccessResponse = {
Expand All @@ -12824,12 +12840,14 @@ export type BrowserRunJsonSuccessResponse = {
success: true;
/** JSON data extracted from the page using an AI model */
result: Record<string, unknown>;
meta: BrowserRunResponseMeta;
};
/** Success response for `markdown` action. */
export type BrowserRunMarkdownSuccessResponse = {
success: true;
/** Extracted markdown content */
result: string;
meta: BrowserRunResponseMeta;
};
/** Error response for BrowserRun actions. */
export type BrowserRunErrorResponse = {
Expand Down
18 changes: 18 additions & 0 deletions types/generated-snapshot/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12455,11 +12455,25 @@ type BrowserRunJsonOptions = BrowserRunCommonOptions &
);
type BrowserRunContentOptions = BrowserRunCommonOptions;
type BrowserRunMarkdownOptions = BrowserRunCommonOptions;
type BrowserRunRedirectHop = {
/** URL that returned the redirect. */
url: string;
/** HTTP status of the redirect. */
status: number;
/** Redirect response headers, including `location`. */
headers: Record<string, string>;
};
type BrowserRunResponseMeta = {
/** HTTP status code of the rendered page */
status: number;
/** Page title */
title: string;
/** Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted. */
headers?: Record<string, string>;
/** URL that served the response, after any redirects the browser followed. */
finalUrl?: string;
/** HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read. */
redirectChain?: BrowserRunRedirectHop[];
};
/** Success response for `content` action. */
type BrowserRunContentSuccessResponse = {
Expand All @@ -12473,6 +12487,7 @@ type BrowserRunLinksSuccessResponse = {
success: true;
/** Extracted links */
result: string[];
meta: BrowserRunResponseMeta;
};
/** Success response for `scrape` action. */
type BrowserRunScrapeSuccessResponse = {
Expand Down Expand Up @@ -12503,6 +12518,7 @@ type BrowserRunScrapeSuccessResponse = {
}>;
}>;
}>;
meta: BrowserRunResponseMeta;
};
/** Success response for `snapshot` action. */
type BrowserRunSnapshotSuccessResponse = {
Expand All @@ -12520,12 +12536,14 @@ type BrowserRunJsonSuccessResponse = {
success: true;
/** JSON data extracted from the page using an AI model */
result: Record<string, unknown>;
meta: BrowserRunResponseMeta;
};
/** Success response for `markdown` action. */
type BrowserRunMarkdownSuccessResponse = {
success: true;
/** Extracted markdown content */
result: string;
meta: BrowserRunResponseMeta;
};
/** Error response for BrowserRun actions. */
type BrowserRunErrorResponse = {
Expand Down
18 changes: 18 additions & 0 deletions types/generated-snapshot/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12469,11 +12469,25 @@ export type BrowserRunJsonOptions = BrowserRunCommonOptions &
);
export type BrowserRunContentOptions = BrowserRunCommonOptions;
export type BrowserRunMarkdownOptions = BrowserRunCommonOptions;
export type BrowserRunRedirectHop = {
/** URL that returned the redirect. */
url: string;
/** HTTP status of the redirect. */
status: number;
/** Redirect response headers, including `location`. */
headers: Record<string, string>;
};
export type BrowserRunResponseMeta = {
/** HTTP status code of the rendered page */
status: number;
/** Page title */
title: string;
/** Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted. */
headers?: Record<string, string>;
/** URL that served the response, after any redirects the browser followed. */
finalUrl?: string;
/** HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read. */
redirectChain?: BrowserRunRedirectHop[];
};
/** Success response for `content` action. */
export type BrowserRunContentSuccessResponse = {
Expand All @@ -12487,6 +12501,7 @@ export type BrowserRunLinksSuccessResponse = {
success: true;
/** Extracted links */
result: string[];
meta: BrowserRunResponseMeta;
};
/** Success response for `scrape` action. */
export type BrowserRunScrapeSuccessResponse = {
Expand Down Expand Up @@ -12517,6 +12532,7 @@ export type BrowserRunScrapeSuccessResponse = {
}>;
}>;
}>;
meta: BrowserRunResponseMeta;
};
/** Success response for `snapshot` action. */
export type BrowserRunSnapshotSuccessResponse = {
Expand All @@ -12534,12 +12550,14 @@ export type BrowserRunJsonSuccessResponse = {
success: true;
/** JSON data extracted from the page using an AI model */
result: Record<string, unknown>;
meta: BrowserRunResponseMeta;
};
/** Success response for `markdown` action. */
export type BrowserRunMarkdownSuccessResponse = {
success: true;
/** Extracted markdown content */
result: string;
meta: BrowserRunResponseMeta;
};
/** Error response for BrowserRun actions. */
export type BrowserRunErrorResponse = {
Expand Down
Loading