v1

latestOpenAPI 3.0.12026-07-269427.8 KB

Get agent job by ID (v1)

Deprecated: use v2 get agent job instead. Retrieves the details and status of a specific agent job by its ID.

Authenticate with an admin API key.

get/v1/agent/{projectId}/job/{id}

projectIdstring required

Your project ID. Can be copied from the API keys page in your dashboard.

idstring required

The unique identifier of the agent job to retrieve.

Agent job details retrieved successfully

sessionIdstring

The subdomain this session belongs to.

subdomainstring

The subdomain this session belongs to.

branchstring nullable

Git branch name where changes were made.

haultedboolean

Whether the session execution was halted.

haultReason'completed' | 'github_missconfigured' | 'error' | 'processing' | 'interrupted'

Reason for session halt. processing indicates the job is still running. interrupted indicates the job was manually interrupted.

pullRequestLinkstring

Link to the created pull request.

messageToUserstring

Message for the user about the session outcome.

userIdstring

The ID of the user who created this session, if available.

titlestring

A generated title summarizing the agent job.

createdAtstring date-time

Timestamp when the session was created.