Hivebrowser
API Reference

Artifacts

Capture screenshots, generate PDFs, and extract page content.

Use whenA run needs durable output

Capture proof for reports, downstream jobs, reviews, or customers.

ChooseScreenshot, PDF, or content

Use screenshots for pixels, PDFs for pages, content for text or HTML.

TraceStore artifact ids

Save artifact ids with your job records so metadata and content can be fetched later.

Output Boundary

Use screenshots for visual proof and failed-run review, PDFs for document pages such as invoices or reports, and content extraction when downstream systems need text or HTML. For every artifact, persist the artifact id with your job record so metadata and content can be retrieved later.

Capture Screenshot

POST/v1/screenshotShow endpoint detailsHide endpoint details
POST/v1/screenshot

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
sessionIdRequiredstring

Session to capture

Minimum length: 1
fullPageboolean

Capture the full scrollable page

Default: false
formatstring

Image output format

Default: "png"Value in: "png" | "jpeg"
qualityinteger

JPEG quality (1-100, only applies to jpeg format)

Minimum: 1Maximum: 100
cURL
curl -X POST "https://api.hivebrowser.ai/v1/screenshot" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "fullPage": false,    "format": "png",    "quality": 1  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/screenshot", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "fullPage": false,    "format": "png",    "quality": 1  })});
Response 201

Screenshot captured

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Capture PDF

POST/v1/pdfShow endpoint detailsHide endpoint details
POST/v1/pdf

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
sessionIdRequiredstring

Session to capture

Minimum length: 1
formatstring

Paper format (e.g., A4, Letter)

Default: "A4"
landscapeboolean

Use landscape orientation

Default: false
printBackgroundboolean

Print background graphics

Default: true
cURL
curl -X POST "https://api.hivebrowser.ai/v1/pdf" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "format": "A4",    "landscape": false,    "printBackground": true  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/pdf", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "format": "A4",    "landscape": false,    "printBackground": true  })});
Response 201

PDF captured

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Extract Page Content

POST/v1/contentShow endpoint detailsHide endpoint details
POST/v1/content

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
sessionIdRequiredstring

Session to extract content from

Minimum length: 1
includeHtmlboolean

Include raw HTML in the response

Default: true
includeTextboolean

Include extracted text in the response

Default: true
cURL
curl -X POST "https://api.hivebrowser.ai/v1/content" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "includeHtml": true,    "includeText": true  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/content", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "includeHtml": true,    "includeText": true  })});
Response 201

Content extracted

Response example
{
  "data": {
    "artifact": {
      "id": "string",
      "teamId": "string",
      "sessionId": "string",
      "type": "SCREENSHOT",
      "storageKey": "string",
      "contentType": "string",
      "sizeBytes": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "downloadUrl": "http://example.com"
    },
    "content": {
      "url": "string",
      "title": "string",
      "html": "string",
      "text": "string"
    }
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Get Artifact Metadata

GET/v1/artifacts/{id}Show endpoint detailsHide endpoint details
GET/v1/artifacts/{id}

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Path Parameters

idRequiredstring

Artifact ID

cURL
curl -X GET "https://api.hivebrowser.ai/v1/artifacts/string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/artifacts/string", {  headers: {    "Authorization": "Bearer <token>"  }});
Response 200

Artifact metadata

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Download Artifact Content

GET/v1/artifacts/{id}/contentShow endpoint detailsHide endpoint details
GET/v1/artifacts/{id}/content

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Path Parameters

idRequiredstring

Artifact ID

Query Parameters

tokenstring

Artifact access token for unauthenticated download

cURL
curl -X GET "https://api.hivebrowser.ai/v1/artifacts/string/content?token=string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/artifacts/string/content?token=string", {  headers: {    "Authorization": "Bearer <token>"  }});
Response 200

Artifact content (content-type varies by artifact type)

Response example
"string"
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

On this page

Output BoundaryCapture ScreenshotCapture PDFExtract Page ContentGet Artifact MetadataDownload Artifact Content