Skip to content
Talk to salesGet started
Talk to sales

Generated reference

Grep API v2

Run research jobs and read their results. Pin the effort tier or expert, fetch the rendered report and any files it produced, and check your credit balance before each call.

Browse developer docs

Current: API v2 reference

API reference

Endpoints

The 128 operations in the current public OpenAPI document, grouped as it tags them. The full reference below carries each one's parameters, request body, responses and examples.

Agent-to-Agent

  • POST/api/v2/a2aA2A Jsonrpc

Agents

  • GET/api/v2/agentsList public agents
  • POST/api/v2/agentsCreate a custom agent
  • POST/api/v2/agents/applyApply a declarative agent manifest
  • POST/api/v2/agents/buildStart an async agent build
  • GET/api/v2/agents/build/{run_id}Get agent build status
  • GET/api/v2/agents/customList your custom agents
  • POST/api/v2/agents/extractPreview config extraction from pasted text
  • POST/api/v2/agents/generate-workflowPreview a generated workflow for an SOP
  • POST/api/v2/agents/validateValidate an agent config without saving
  • GET/api/v2/agents/{agent_id}Get an agent's configuration
  • DELETE/api/v2/agents/{agent_id}Archive a custom agent
  • PATCH/api/v2/agents/{agent_id}Update a custom agent
  • GET/api/v2/agents/{agent_id}/context-filesList context files
  • POST/api/v2/agents/{agent_id}/context-filesAttach a context file
  • POST/api/v2/agents/{agent_id}/context-files/importImport a context file by URL or from an attachment
  • GET/api/v2/agents/{agent_id}/context-files/{name}Download a context file
  • DELETE/api/v2/agents/{agent_id}/context-files/{name}Remove a context file
  • POST/api/v2/agents/{agent_id}/plan-previewPreview the research plan for a question
  • GET/api/v2/agents/{agent_id}/shareList shares
  • POST/api/v2/agents/{agent_id}/shareShare an agent
  • DELETE/api/v2/agents/{agent_id}/shareRevoke a share
  • GET/api/v2/agents/{agent_id}/versionsList configuration versions
  • GET/api/v2/agents/{agent_id}/versions/{version_num}Get one configuration version
  • POST/api/v2/agents/{agent_id}/versions/{version_num}/restoreRestore a configuration version
  • POST/api/v2/agents/{agent_id}/visibilitySet public/private visibility
  • GET/api/v2/expertsList public agents
  • POST/api/v2/expertsCreate a custom agent
  • POST/api/v2/experts/applyApply a declarative agent manifest
  • POST/api/v2/experts/buildStart an async agent build
  • GET/api/v2/experts/build/{job_id}Get agent build status
  • GET/api/v2/experts/customList your custom agents
  • POST/api/v2/experts/extractPreview config extraction from pasted text
  • POST/api/v2/experts/generate-workflowPreview a generated workflow for an SOP
  • GET/api/v2/experts/mcp-toolsList MCP tools available to agents
  • GET/api/v2/experts/skillsList skills available to agents
  • POST/api/v2/experts/skillsCreate a custom skill
  • GET/api/v2/experts/skills/{skill_name}Read a skill's SKILL.md
  • POST/api/v2/experts/validateValidate an agent config without saving
  • GET/api/v2/experts/{expert_id}Get an agent's configuration
  • DELETE/api/v2/experts/{expert_id}Archive a custom agent
  • PATCH/api/v2/experts/{expert_id}Update a custom agent
  • GET/api/v2/experts/{expert_id}/context-filesList context files
  • POST/api/v2/experts/{expert_id}/context-filesAttach a context file
  • POST/api/v2/experts/{expert_id}/context-files/importImport a context file by URL or from an attachment
  • GET/api/v2/experts/{expert_id}/context-files/{name}Download a context file
  • DELETE/api/v2/experts/{expert_id}/context-files/{name}Remove a context file
  • POST/api/v2/experts/{expert_id}/plan-previewPreview the research plan for a question
  • GET/api/v2/experts/{expert_id}/shareList shares
  • POST/api/v2/experts/{expert_id}/shareShare an agent
  • DELETE/api/v2/experts/{expert_id}/shareRevoke a share
  • GET/api/v2/experts/{expert_id}/versionsList configuration versions
  • GET/api/v2/experts/{expert_id}/versions/{version_num}Get one configuration version
  • POST/api/v2/experts/{expert_id}/versions/{version_num}/restoreRestore a configuration version
  • POST/api/v2/experts/{expert_id}/visibilitySet public/private visibility
  • GET/api/v2/integrationsList MCP tools available to agents
  • GET/api/v2/skillsList skills available to agents
  • POST/api/v2/skillsCreate a custom skill
  • GET/api/v2/skills/{skill_name}Read a skill's SKILL.md

Campaigns

  • POST/api/v2/agents/{agent_id}/campaignsRun an agent's campaign
  • GET/api/v2/campaignsList Campaigns
  • POST/api/v2/campaignsCreate Campaign
  • POST/api/v2/campaigns/validateValidate Campaign
  • GET/api/v2/campaigns/{campaign_id}Get Campaign
  • PATCH/api/v2/campaigns/{campaign_id}Update Campaign
  • POST/api/v2/campaigns/{campaign_id}/approveApprove Campaign
  • GET/api/v2/campaigns/{campaign_id}/artifacts/{deliverable_key}Download Campaign Artifact
  • GET/api/v2/campaigns/{campaign_id}/browser-sessionsGet Campaign Browser Sessions
  • POST/api/v2/campaigns/{campaign_id}/cancelCancel Campaign
  • GET/api/v2/campaigns/{campaign_id}/portfolioGet Campaign Portfolio
  • POST/api/v2/campaigns/{campaign_id}/retryRetry Campaign
  • POST/api/v2/experts/{expert_id}/campaignsRun an agent's campaign

Attachments

  • POST/api/v2/attachmentsCreate an attachment
  • POST/api/v2/attachments/importCreate an attachment from a URL
  • POST/api/v2/attachments/uploadsBegin Attachment Upload
  • GET/api/v2/attachments/{attachment_id}Get an attachment
  • DELETE/api/v2/attachments/{attachment_id}Delete an attachment
  • PUT/api/v2/attachments/{attachment_id}/contentUpload Attachment Content

Batch schedules

  • GET/api/v2/batch-schedules/{schedule_id}Get Batch Schedule
  • DELETE/api/v2/batch-schedules/{schedule_id}Delete Batch Schedule
  • PATCH/api/v2/batch-schedules/{schedule_id}Patch Batch Schedule
  • POST/api/v2/batch-schedules/{schedule_id}/pausePause Batch Schedule Endpoint
  • POST/api/v2/batch-schedules/{schedule_id}/resumeResume Batch Schedule Endpoint
  • POST/api/v2/batch-schedules/{schedule_id}/run-nowRun Batch Schedule Now
  • POST/api/v2/loopsCreate Loop
  • GET/api/v2/loops/{schedule_id}Resource Get Batch Schedule
  • DELETE/api/v2/loops/{schedule_id}Resource Delete Batch Schedule
  • PATCH/api/v2/loops/{schedule_id}Resource Patch Batch Schedule
  • POST/api/v2/loops/{schedule_id}/pauseResource Pause Batch Schedule Endpoint
  • POST/api/v2/loops/{schedule_id}/resumeResource Resume Batch Schedule Endpoint
  • POST/api/v2/loops/{schedule_id}/run-nowResource Run Batch Schedule Now

Batches

  • GET/api/v2/batchesList your batches
  • POST/api/v2/batchesCreate a batch
  • GET/api/v2/batches/estimateEstimate a batch's credit cost
  • GET/api/v2/batches/{batch_id}Get a batch
  • POST/api/v2/batches/{batch_id}/cancelCancel a batch
  • GET/api/v2/batches/{batch_id}/resultsGet batch row results, all at once or a page at a time
  • POST/api/v2/batches/{batch_id}/retry-failedRetry every failed batch row
  • POST/api/v2/batches/{batch_id}/rows/{row_number}/retryRetry one failed batch row

Billing

  • GET/api/v2/billing/transactionsGet Billing Transactions
  • GET/api/v2/billing/usageGet Billing Usage
  • GET/api/v2/quotaGet Quota
  • GET/api/v2/quota/checkCheck Quota
  • GET/api/v2/usageResource Get Billing Usage

API Keys

  • GET/api/v2/keysList your API keys
  • POST/api/v2/keysCreate an API key
  • DELETE/api/v2/keys/{key_id}Revoke an API key

Runs

  • GET/api/v2/researchList runs
  • POST/api/v2/researchStart a run
  • GET/api/v2/research/{job_id_or_slug}Get a run
  • PATCH/api/v2/research/{job_id_or_slug}Update a run
  • POST/api/v2/research/{job_id_or_slug}/cancelCancel a run
  • POST/api/v2/research/{job_id_or_slug}/continueContinue a run
  • GET/api/v2/research/{job_id_or_slug}/filesList a run's files
  • GET/api/v2/research/{job_id_or_slug}/files/{file_path}Read a run's file
  • GET/api/v2/research/{job_id_or_slug}/timelineGet a run's timeline
  • GET/api/v2/runList runs
  • POST/api/v2/runStart a run
  • GET/api/v2/run/{job_id_or_slug}Get a run
  • GET/api/v2/runsList runs
  • POST/api/v2/runsStart a run
  • GET/api/v2/runs/{run_id_or_slug}Get a run
  • PATCH/api/v2/runs/{run_id_or_slug}Update a run
  • POST/api/v2/runs/{run_id_or_slug}/cancelCancel a run
  • POST/api/v2/runs/{run_id_or_slug}/continueContinue a run
  • GET/api/v2/runs/{run_id_or_slug}/filesList a run's files
  • GET/api/v2/runs/{run_id_or_slug}/files/{file_path}Read a run's file
  • GET/api/v2/runs/{run_id_or_slug}/timelineGet a run's timeline

Live specification · V2

Generated OpenAPI reference

The complete contract below comes from the current public OpenAPI document, never from an editor-managed operation list.

OpenAPI JSONMarkdown mirror

Checking generated source…

Loading the generated API reference…