Skip to main content
GET
/
workspaces
/
{workspaceId}
/
crawler
/
jobs
/
{jobId}
Get crawler job
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/workspaces/{workspaceId}/crawler/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "primaryUrl": "<string>",
    "urls": [
      "<string>"
    ],
    "crawl": true,
    "crawlOptions": {
      "maxPages": 250,
      "urlMatchers": [
        "<string>"
      ],
      "unMatchers": [
        "<string>"
      ],
      "stayOnDomain": true
    },
    "useProxy": true,
    "deep": true,
    "refreshRate": "<string>",
    "toAgentId": "<string>",
    "toAgentIds": [
      "<string>"
    ],
    "done": true,
    "failed": true,
    "isCancelled": true,
    "message": "<string>",
    "resultError": "<string>",
    "createdAt": "<string>",
    "ts": 123,
    "currentPageIndex": 123,
    "scrapedPagesNum": 123,
    "failedPagesNum": 123,
    "pageLimit": 123,
    "creditsPerPage": 123,
    "estimatedCredits": 123,
    "activeScrapeUrl": "<string>",
    "crawlerJobId": "<string>",
    "scrapedUrls": [
      "<string>"
    ],
    "scrapedHashes": [
      "<string>"
    ],
    "pendingCandidateUrls": [
      "<string>"
    ],
    "processedCrawlUrls": [
      "<string>"
    ],
    "failedCrawlUrls": [
      "<string>"
    ],
    "webhookFinalizedAt": "<string>",
    "processingMode": "<string>",
    "crawlerSubmittedAt": "<string>",
    "crawlerWebhookUrl": "<string>",
    "crawlerSubmissionEndpoint": "<string>",
    "webhook": {
      "url": "<string>",
      "events": [],
      "hasSecret": true,
      "hasBearerToken": true,
      "headerKeys": [
        "<string>"
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.convocore.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Returns one crawler job with its current processing state, scraped URL tracking, and webhook metadata.
Crawler jobs cannot be updated after submission. This endpoint is read-only.

Typical Use Cases

  • Polling job progress
  • Reading final job status
  • Inspecting webhook delivery configuration
  • Reviewing discovered and processed URLs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
jobId
string
required

Response

Successful response

success
boolean
required
message
string
required
data
object
required