Skip to content

BrowserApi.md

Latest commit

 

History

History
312 lines (244 loc) · 10.9 KB

BrowserApi.md

File metadata and controls

312 lines (244 loc) · 10.9 KB

BrowserApi

All URIs are relative to https://api.unifapi.com

Method HTTP request Description
browserHtmlPost POST /browser/html Render a page to HTML
browserLinksPost POST /browser/links Extract links from a page
browserMarkdownPost POST /browser/markdown Render a page to Markdown
browserScreenshotPost POST /browser/screenshot Capture a page screenshot

browserHtmlPost

BrowserHtmlPost200Response browserHtmlPost(browserHtmlRequest)

Render a page to HTML

Render a URL in a headless browser and return the fully rendered HTML after JavaScript execution — use it to read meta tags, structured data, and content that only appears after client-side rendering.

Example

// Import classes:
import com.unifapi.sdk.ApiClient;
import com.unifapi.sdk.ApiException;
import com.unifapi.sdk.Configuration;
import com.unifapi.sdk.auth.*;
import com.unifapi.sdk.models.*;
import com.unifapi.sdk.api.BrowserApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.unifapi.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    BrowserApi apiInstance = new BrowserApi(defaultClient);
    BrowserHtmlRequest browserHtmlRequest = new BrowserHtmlRequest(); // BrowserHtmlRequest | 
    try {
      BrowserHtmlPost200Response result = apiInstance.browserHtmlPost(browserHtmlRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrowserApi#browserHtmlPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
browserHtmlRequest BrowserHtmlRequest [optional]

Return type

BrowserHtmlPost200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

browserLinksPost

BrowserLinksPost200Response browserLinksPost(browserLinksRequest)

Extract links from a page

Render a URL in a headless browser and return every link on the page as absolute URLs, including links injected by JavaScript. Optionally restrict to visible links or same-domain links for internal-link and broken-link audits.

Example

// Import classes:
import com.unifapi.sdk.ApiClient;
import com.unifapi.sdk.ApiException;
import com.unifapi.sdk.Configuration;
import com.unifapi.sdk.auth.*;
import com.unifapi.sdk.models.*;
import com.unifapi.sdk.api.BrowserApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.unifapi.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    BrowserApi apiInstance = new BrowserApi(defaultClient);
    BrowserLinksRequest browserLinksRequest = new BrowserLinksRequest(); // BrowserLinksRequest | 
    try {
      BrowserLinksPost200Response result = apiInstance.browserLinksPost(browserLinksRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrowserApi#browserLinksPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
browserLinksRequest BrowserLinksRequest [optional]

Return type

BrowserLinksPost200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

browserMarkdownPost

BrowserMarkdownPost200Response browserMarkdownPost(browserMarkdownRequest)

Render a page to Markdown

Render a URL in a headless browser (running JavaScript) and return the page as clean Markdown — ideal for content analysis, summarization, and feeding pages to language models.

Example

// Import classes:
import com.unifapi.sdk.ApiClient;
import com.unifapi.sdk.ApiException;
import com.unifapi.sdk.Configuration;
import com.unifapi.sdk.auth.*;
import com.unifapi.sdk.models.*;
import com.unifapi.sdk.api.BrowserApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.unifapi.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    BrowserApi apiInstance = new BrowserApi(defaultClient);
    BrowserMarkdownRequest browserMarkdownRequest = new BrowserMarkdownRequest(); // BrowserMarkdownRequest | 
    try {
      BrowserMarkdownPost200Response result = apiInstance.browserMarkdownPost(browserMarkdownRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrowserApi#browserMarkdownPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
browserMarkdownRequest BrowserMarkdownRequest [optional]

Return type

BrowserMarkdownPost200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

browserScreenshotPost

BrowserScreenshotPost200Response browserScreenshotPost(browserScreenshotRequest)

Capture a page screenshot

Render a URL in a headless browser and capture a screenshot, returned as a base64-encoded image. Control the viewport, capture the full scrollable page, target a CSS selector, and choose png, jpeg, or webp output.

Example

// Import classes:
import com.unifapi.sdk.ApiClient;
import com.unifapi.sdk.ApiException;
import com.unifapi.sdk.Configuration;
import com.unifapi.sdk.auth.*;
import com.unifapi.sdk.models.*;
import com.unifapi.sdk.api.BrowserApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.unifapi.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    BrowserApi apiInstance = new BrowserApi(defaultClient);
    BrowserScreenshotRequest browserScreenshotRequest = new BrowserScreenshotRequest(); // BrowserScreenshotRequest | 
    try {
      BrowserScreenshotPost200Response result = apiInstance.browserScreenshotPost(browserScreenshotRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrowserApi#browserScreenshotPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
browserScreenshotRequest BrowserScreenshotRequest [optional]

Return type

BrowserScreenshotPost200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -