Skip to main content
POST
/
v2
/
agents
/
execution
/
get
Get Execution
curl --request POST \
  --url https://api.velt.dev/v2/agents/execution/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "executionId": "<string>",
    "includeResults": true
  }
}
'
{
  "result": {
    "status": "success",
    "message": "Execution fetched successfully",
    "data": {
      "execution": {
        "id": "exec_1711900000000_abc123def456",
        "status": "running",
        "startedAt": 1711900000000,
        "completedAt": null,
        "durationMs": null
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://velt-raghul-agent-docs.mintlify.app/llms.txt

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

Use this API to fetch an execution document by ID. This is the polling endpoint — call it after Run Execution and poll until execution.status !== "running". Set includeResults: true to also fetch the per-URL findings subcollection.

Endpoint

POST https://api.velt.dev/v2/agents/execution/get

Headers

x-velt-api-key
string
required
Your API key.
x-velt-auth-token
string
required

Body

Params

data
object
required

Example Requests

1. Poll status only

{
  "data": {
    "executionId": "exec_1711900000000_abc123def456"
  }
}

2. Fetch with full results

{
  "data": {
    "executionId": "exec_1711900000000_abc123def456",
    "includeResults": true
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Execution fetched successfully",
    "data": {
      "execution": {
        "id": "exec_1711900000000_abc123def456",
        "agentId": "abc123def456",
        "agentName": "Brand Consistency Checker",
        "agentVersion": 3,
        "metadata": {
          "apiKey": "ak_xxx",
          "organizationId": "server_org_001",
          "clientOrganizationId": "org_001",
          "documentId": "server_doc_001",
          "clientDocumentId": "doc_001"
        },
        "config": {
          "seedUrl": "https://example.com",
          "crossPageExecute": true,
          "maxUrlsToProcess": 25,
          "crawlerConfig": { "maxPages": 100, "timeout": 300000, "maxDepth": 0 }
        },
        "status": "passed",
        "startedAt": 1711900000000,
        "completedAt": 1711900150000,
        "durationMs": 150000,
        "trigger": "standalone",
        "workflowExecutionId": null,
        "previousExecutionId": null,
        "ranBy": { "userId": "user_123", "name": "Jane Doe", "email": "jane@example.com" },
        "resultsSummary": {
          "totalFindings": 7,
          "totalAnnotationsCreated": 5,
          "urlsProcessed": 12,
          "urlsWithFindings": 5,
          "issuesCreated": 7,
          "summary": "Found 7 issues across 12 pages. 5 annotations created, 2 matched existing annotations.",
          "matchResult": { "created": 5, "skipped": 2, "resolved": 1 }
        },
        "crawlerResults": { "status": "completed", "totalUrlsFound": 12, "duration": 45000, "pagesVisited": 12 },
        "llmModel": "claude/claude-sonnet-4-6",
        "tokenUsage": {
          "promptTokens": 12500,
          "completionTokens": 3200,
          "thoughtsTokens": 0,
          "totalTokens": 15700
        },
        "knowledgeRetrieved": true,
        "knowledgeCached": false,
        "degraded": false
      }
    }
  }
}

Execution document fields

FieldTypeDescription
idstringExecution ID
agentIdstringAgent that was executed
agentNamestringDenormalized agent display name
agentVersionnumberAgent config version pinned at dispatch time
metadata.apiKeystringWorkspace API key
metadata.organizationIdstringServer-namespaced organization ID
metadata.clientOrganizationIdstringClient-provided organization ID
metadata.documentIdstringServer-namespaced document ID
metadata.clientDocumentIdstringClient-provided document ID
config.seedUrlstringThe seed URL provided by the user
config.crossPageExecutebooleanWhether cross-page mode was used
config.maxUrlsToProcessnumberMax URLs limit
config.crawlerConfigobject | undefinedCrawler config (only when crossPageExecute: true)
statusstring"running", "passed", "failed", "error", "skipped"
startedAtnumberEpoch ms
completedAtnumber | nullEpoch ms when completed; null while running
durationMsnumber | nullTotal duration in ms
errorobject | undefinedPopulated on error or failed status
error.codestringOne of TIMEOUT, LLM_ERROR, LLM_RATE_LIMITED, MALFORMED_RESPONSE, CRAWLER_ERROR, EXTRACTION_ERROR, POST_PROCESS_ERROR, INTERNAL
error.messagestringHuman-readable error description
error.retryablebooleanWhether this error can be retried
error.advisoryCommentstring | undefinedAdvisory comment text posted to the document
error.occurredAtnumberEpoch ms
triggerstring"standalone" or "workflow"
workflowExecutionIdstring | undefinedParent workflow execution ID (workflow-triggered runs)
previousExecutionIdstring | undefinedPrevious execution ID (for match-and-merge reruns)
ranBy.userIdstringUser ID
ranBy.namestringDisplay name
ranBy.emailstringEmail
resultsSummary.totalFindingsnumberTotal findings (after guardrails filtering)
resultsSummary.totalAnnotationsCreatednumberAnnotations created (after match-and-merge dedup)
resultsSummary.urlsProcessednumberURLs processed
resultsSummary.urlsWithFindingsnumberURLs that had at least one finding
resultsSummary.matchResultobject | undefined{ created, skipped, resolved } — match-and-merge outcome
crawlerResultsobject | undefinedOnly populated when crossPageExecute: true
llmModelstring | undefinedLLM model used (e.g. "claude/claude-sonnet-4-6")
tokenUsageobject{ promptTokens, completionTokens, thoughtsTokens, totalTokens }
knowledgeRetrievedboolean | undefinedWhether knowledge was retrieved from Memory
knowledgeCachedboolean | undefinedWhether knowledge retrieval was served from cache
degradedboolean | undefinedWhether the agent ran in degraded mode

Success Response (with results — includeResults: true)

{
  "result": {
    "status": "success",
    "message": "Execution fetched successfully",
    "data": {
      "execution": { "...same as above..." },
      "results": [
        {
          "url": "https://example.com",
          "urlHash": "a1b2c3d4e5f6",
          "findings": [
            {
              "id": "finding-1",
              "title": "Heading uses wrong font",
              "description": "The h1 element uses 'Arial' instead of brand font 'Inter'",
              "severity": "high",
              "category": "typography",
              "targetText": "Welcome to Example",
              "occurrence": 1,
              "sourceUrl": "https://example.com",
              "suggestion": "Change font-family to 'Inter' for the h1 element",
              "htmlSelector": "h1.hero-title",
              "htmlXpath": "/html/body/main/section[1]/h1",
              "isPageLevel": false,
              "issueType": "brand-font",
              "confidence": 92
            }
          ],
          "findingCount": 1,
          "annotationsCreated": 1,
          "processedAt": 1711900050000
        }
      ]
    }
  }
}

Per-URL result fields

FieldTypeDescription
urlstringThe URL analyzed
urlHashstringMD5 hash of the URL (Firestore doc ID)
findingsobject[]Array of AgentFinding objects
findingCountnumberNumber of findings for this URL
annotationsCreatednumberAnnotations created for this URL
processedAtnumberEpoch ms when this URL was processed

Finding fields (AgentFinding)

FieldTypeRequiredDescription
idstringyesUnique finding ID (e.g. "finding-1")
titlestringyesShort title
descriptionstringyesDetailed description
severitystringyescritical, high, medium, low, info
categorystringnoGrouping tag (e.g. accessibility, seo, content, layout)
targetTextstringyesExact DOM text. Empty string for image/non-text findings
occurrencenumberno1-based occurrence index of targetText on the page
sourceUrlstringnoURL where the finding was detected
suggestionstringnoSuggested fix
htmlSelectorstringyesCSS selector of the DOM element
htmlXpathstringyesXPath of the DOM element
htmlSnippetstringnoSurrounding HTML snippet for context
isPageLevelbooleanyestrue for visual/layout findings; false when targetText matches DOM text
issueTypestringnoMatch-and-merge key (e.g. "casing", "pii", "spelling")
confidencenumberno0-100. Findings below 50 may be suppressed by guardrails
commentIdstringnoComment annotation ID populated after annotation creation
sourcestringno"instructions" or "knowledge"
metadataobjectnoAdditional finding-specific metadata

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "NOT_FOUND"
  }
}
Errors: NOT_FOUND (execution or store database not found) / INVALID_ARGUMENT (missing or empty executionId).
{
  "result": {
    "status": "success",
    "message": "Execution fetched successfully",
    "data": {
      "execution": {
        "id": "exec_1711900000000_abc123def456",
        "status": "running",
        "startedAt": 1711900000000,
        "completedAt": null,
        "durationMs": null
      }
    }
  }
}