GRgrep
grep-public-api

Get Research Job

Get details of a research job by ID or slug.

Accepts either a UUID (e.g., /research/550e8400-...) or a human-readable slug (e.g., /research/what-is-stripe). Backward-compatible: UUID URLs keep working with zero DB overhead.

All auth modes supported. Public jobs can be read in capability mode with only the job_id.

get/api/v1/run/{job_id}

Request

  • Base URL
    https://api.grep.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.grep.ai/api/v1/run/{job_id}
  • Auth
    none declared

Path parameters

string uuid required
OR
string required

Query parameters

include_check_resultsboolean
include_status_messagesboolean
include_sessionboolean

Response

Successful Response

browser_intervention_kind'authentication' | 'user_action' | 'managed_sign_in' nullable

The kind of owner wait behind browser_intervention_state; managed_sign_in asks the owner to sign in.

browser_intervention_state'pending' | 'recovery_required' nullable

Whether browser work is waiting for the owner or needs recovery. Does not grant browser access.

budget_exhaustedboolean nullable

Whether the final logical run ended through the budget wrap-up path.

can_editboolean nullable

Whether the caller can modify this job (owner or admin only).

can_view_activityboolean nullable

Whether the caller may read the job's agent activity (status messages): the owner, a Parcha admin, or a reader granted access to the job's expert.

check_resultsobject[] nullable

Agent output tree, including the final report under grep.open_research. Each item has command_id, status, answer (rendered report), and payload (sources, confidence, structured_output when json_schema was supplied).

completed_atstring nullable

When the job reached a terminal state.

created_atstring nullable

When the job was created.

error_kindstring nullable

Machine-readable failure category, when present: a capped run's failure category, or agent_not_runnable, needs_connection, needs_reconnect or connection_revoked when the Agent's connections stopped the run before any work ran (error_message says what to do).

error_messagestring nullable

Plain-language reason for a failure, when the platform can name one.

failure_codestring nullable

Machine-readable reason a job was rejected before execution, when present.

failure_reasonstring nullable

Human-readable explanation of a pre-execution rejection, when present.

is_publicboolean nullable

Whether this job is publicly viewable without authentication.

job_idstring required

Job UUID.

max_cost_usdnumber nullable

Caller-supplied provider-spend cap for each logical run.

run_completed_atstring nullable
run_started_atstring nullable
sessionobject nullable

Claude session handle for continuing the conversation.

slugstring nullable

Human-readable URL slug.

started_atstring nullable

When the job began executing.

statusstring required

Lifecycle status: queued, moderation, planning, running, completed, failed, blocked.

status_messagesobject[] nullable

Full status message stream emitted by the agent. Large.

Changes

No recorded changes to this operation across all 1 revision of this API.