Get Agent Run

Retrieve the status and result of an agent run.

Returns the current status, progress, and any available results for the specified agent run. The agent run must belong to the specified organization. If the agent run is still in progress, this endpoint can be polled to check for completion.

Rate limit: 60 requests per 30 seconds.

GET /v1/organizations/{org_id}/agent/run/{agent_run_id}

Get Agent Run

cURL

curl --request GET \
  --url https://api.codegen.com/v1/organizations/{org_id}/agent/run/{agent_run_id}

200

{
  "id": 123,
  "organization_id": 123,
  "status": "<string>",
  "created_at": "<string>",
  "web_url": "<string>",
  "result": "<string>",
  "summary": "<string>",
  "github_pull_requests": [
    {
      "id": 123,
      "created_at": "<string>",
      "title": "<string>",
      "url": "<string>",
      "head_branch_name": "<string>"
    }
  ],
  "metadata": {}
}

Headers

Path Parameters

agent_run_id · integer · required

org_id · integer · required

Response

200

application/json

Successful Response

Represents an agent run in API responses

id · integer · required

organization_id · integer · required

status · string | null

created_at · string | null

web_url · string | null

result · string | null

summary · string | null

source_type · enum<string> | null

Available options: LOCAL, SLACK, GITHUB, GITHUB_CHECK_SUITE, GITHUB_PR_REVIEW, LINEAR, API, CHAT, JIRA, CLICKUP, MONDAY, SETUP_COMMANDS

github_pull_requests · GithubPullRequestResponse · object[] | null

Show child attributes

metadata · Metadata · object