Passer au contenu principal
GET
/
agent
/
{domain}
/
job
/
{id}
Get agent job by ID
curl --request GET \
  --url https://api-dsc.mintlify.com/v1/agent/{domain}/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "status": "pending",
      "priority": "high",
      "id": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

​
Utilisation

Cet endpoint renvoie les détails et l’état d’un travail d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’un travail d’agent précédemment créé.

​
Détails du job

La réponse inclut des informations telles que :
  • Statut d’exécution du job et état d’achèvement
  • Informations de branche et détails du pull request (demande de fusion)
  • metadata de session et horodatages

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. See the Assistant API Key documentation for details on how to get your API key.

Path Parameters

​
domain
string
required

The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.

​
id
string
required

The unique identifier of the agent job to retrieve.

Response

200 - application/json

Agent job details retrieved successfully

​
sessionId
string

The subdomain this session belongs to.

​
subdomain
string

The subdomain this session belongs to.

​
branch
string | null

Git branch name where changes were made.

​
haulted
boolean

Whether the session execution was halted.

​
haultReason
enum<string>

Reason for session halt.

Available options:
completed,
github_missconfigured,
error
​
pullRequestLink
string

Link to the created pull request.

​
messageToUser
string

Message for the user about the session outcome.

​
todos
object[]

List of todo items from the session.

​
createdAt
string<date-time>

Timestamp when the session was created.

⌘I