api.md

Nimble

Types:

• ExtractResponse
• ExtractAsyncResponse
• ExtractBatchResponse
• MapResponse
• SearchResponse

Methods:

• client.extract({ ...params }) -> ExtractResponse
• client.extractAsync({ ...params }) -> ExtractAsyncResponse
• client.extractBatch({ ...params }) -> ExtractBatchResponse
• client.map({ ...params }) -> MapResponse
• client.search({ ...params }) -> SearchResponse

Shared

Types:

• AutoScrollAction
• ClickAction
• EvalAction
• FetchAction
• FillAction
• GetCookiesAction
• GotoAction
• PressAction
• ScreenshotAction
• ScrollAction
• WaitAction
• WaitForElementAction
• WaitForNavigationAction

Agent

Types:

• AgentListResponse
• AgentGenerateResponse
• AgentGetResponse
• AgentGetGenerationResponse
• AgentRunResponse
• AgentRunAsyncResponse
• AgentRunBatchResponse

Methods:

• client.agent.list({ ...params }) -> AgentListResponse
• client.agent.generate({ ...params }) -> AgentGenerateResponse
• client.agent.get(templateName) -> AgentGetResponse
• client.agent.getGeneration(generationID) -> AgentGetGenerationResponse
• client.agent.run({ ...params }) -> AgentRunResponse
• client.agent.runAsync({ ...params }) -> AgentRunAsyncResponse
• client.agent.runBatch({ ...params }) -> AgentRunBatchResponse

Crawl

Types:

• CrawlListResponse
• CrawlRunResponse
• CrawlStatusResponse
• CrawlTerminateResponse

Methods:

• client.crawl.list({ ...params }) -> CrawlListResponse
• client.crawl.run({ ...params }) -> CrawlRunResponse
• client.crawl.status(id) -> CrawlStatusResponse
• client.crawl.terminate(id) -> CrawlTerminateResponse

Tasks

Types:

• TaskListResponse
• TaskGetResponse
• TaskResultsResponse

Methods:

• client.tasks.list({ ...params }) -> TaskListResponse
• client.tasks.get(taskID) -> TaskGetResponse
• client.tasks.results(taskID) -> TaskResultsResponse

Batches

Types:

• BatchGetResponse
• BatchProgressResponse

Methods:

• client.batches.list() -> void
• client.batches.get(batchID) -> BatchGetResponse
• client.batches.progress(batchID) -> BatchProgressResponse

DomainKnowledge

Types:

• DomainKnowledgeGetDriverResponse

Methods:

• client.domainKnowledge.getDriver({ ...params }) -> DomainKnowledgeGetDriverResponse

Media

Types:

• MediaRunResponse
• MediaRunAsyncResponse

Methods:

• client.media.run({ ...params }) -> MediaRunResponse
• client.media.runAsync({ ...params }) -> MediaRunAsyncResponse

Serp

Types:

• SerpRunResponse
• SerpRunAsyncResponse
• SerpRunBatchResponse

Methods:

• client.serp.run({ ...params }) -> SerpRunResponse
• client.serp.runAsync({ ...params }) -> SerpRunAsyncResponse
• client.serp.runBatch({ ...params }) -> SerpRunBatchResponse

TaskAgent

Types:

• TaskAgentCreateResponse
• TaskAgentUpdateResponse
• TaskAgentListResponse
• TaskAgentGetResponse
• TaskAgentRunResponse

Methods:

• client.taskAgent.create({ ...params }) -> TaskAgentCreateResponse
• client.taskAgent.update(agentID, [ ...body ]) -> TaskAgentUpdateResponse
• client.taskAgent.list({ ...params }) -> TaskAgentListResponse
• client.taskAgent.deactivate(agentID) -> void
• client.taskAgent.get(agentID) -> TaskAgentGetResponse
• client.taskAgent.run(agentID, { ...params }) -> TaskAgentRunResponse

Templates

Types:

• TemplateListResponse
• TemplateGetResponse

Methods:

• client.taskAgent.templates.list({ ...params }) -> TemplateListResponse
• client.taskAgent.templates.get(templateName) -> TemplateGetResponse

Runs

Types:

• RunListResponse
• RunGetResponse
• RunGetResultResponse
• RunStreamEventsResponse

Methods:

• client.taskAgent.runs.list(agentID, { ...params }) -> RunListResponse
• client.taskAgent.runs.cancel(runID, { ...params }) -> void
• client.taskAgent.runs.get(runID, { ...params }) -> RunGetResponse
• client.taskAgent.runs.getResult(runID, { ...params }) -> RunGetResultResponse
• client.taskAgent.runs.streamEvents(runID, { ...params }) -> unknown

Jobs

Types:

• JobCreateResponse
• JobUpdateResponse
• JobListResponse
• JobGetResponse
• JobRunResponse

Methods:

• client.jobs.create({ ...params }) -> JobCreateResponse
• client.jobs.update(jobID, { ...params }) -> JobUpdateResponse
• client.jobs.list({ ...params }) -> JobListResponse
• client.jobs.delete(jobID) -> void
• client.jobs.get(jobID) -> JobGetResponse
• client.jobs.run(jobID) -> JobRunResponse

Runs

Types:

• RunListResponse
• RunCancelResponse
• RunGetResponse

Methods:

• client.jobs.runs.list(jobID, { ...params }) -> RunListResponse
• client.jobs.runs.cancel(runID) -> RunCancelResponse
• client.jobs.runs.get(runID) -> RunGetResponse

Artifacts

Types:

• ArtifactListResponse
• ArtifactDownloadURLResponse
• ArtifactGetResponse
• ArtifactPreviewResponse

Methods:

• client.jobs.runs.artifacts.list(runID) -> ArtifactListResponse
• client.jobs.runs.artifacts.downloadURL(artifactID, { ...params }) -> ArtifactDownloadURLResponse
• client.jobs.runs.artifacts.get(artifactID, { ...params }) -> ArtifactGetResponse
• client.jobs.runs.artifacts.preview(artifactID, { ...params }) -> ArtifactPreviewResponse