Obtenir une tâche d’agent (v1)

GET

agent

{projectId}

job

{id}

Récupérer une tâche d’agent par ID (v1)

curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mintlify.com/v1/agent/{projectId}/job/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/agent/{projectId}/job/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/agent/{projectId}/job/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/agent/{projectId}/job/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/agent/{projectId}/job/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/agent/{projectId}/job/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Ce point de terminaison est obsolète. Utilisez plutôt le point de terminaison v2 get agent job.

Utilisation

Ce point de terminaison récupère les détails et l’état d’une tâche d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’une tâche d’agent créée précédemment.

Détails du job

La réponse inclut des informations telles que :

Statut d’exécution du job et état d’achèvement
Informations sur la branche et détails du pull request (demande de fusion)
metadata de session et horodatages

Authorizations

Authorization

string

header

required

L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé API d’administrateur (préfixée par mint_). Il s’agit d’une clé secrète côté serveur. Générez-en une sur la page des clés API dans votre Dashboard Mintlify.

Path Parameters

projectId

string

required

L’ID de votre projet. Vous pouvez le copier depuis la page API keys de votre Dashboard.

string

required

L’identifiant unique de la tâche d’agent à récupérer.

Response

200 - application/json

Détails de la tâche d’agent récupérés avec succès

sessionId

string

Le sous-domaine auquel cette session appartient.

subdomain

string

Le sous-domaine auquel cette session appartient.

branch

string | null

Nom de la branche Git où les modifications ont été effectuées.

haulted

boolean

Indique si l’exécution de la session a été interrompue.

haultReason

enum<string>

Motif de l'interruption de la session. processing indique que la tâche est en cours. interrupted indique que la tâche a été interrompue manuellement.

Available options:

completed,

github_missconfigured,

error,

processing,

interrupted

pullRequestLink

string

Lien vers la pull request (demande de fusion) créée.

messageToUser

string

Message destiné à l’utilisateur concernant l’issue de la session.

todos

object[]

Liste des éléments de la liste de tâches de la session.

Show child attributes

userId

string

ID de l’utilisateur ayant créé cette session, si disponible.

title

string

Titre généré résumant la tâche de l’agent.

createdAt

string<date-time>

Horodatage de création de la session.

Récupérer une tâche d’agent par ID (v1)

curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mintlify.com/v1/agent/{projectId}/job/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/agent/{projectId}/job/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/agent/{projectId}/job/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/agent/{projectId}/job/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/agent/{projectId}/job/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/agent/{projectId}/job/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

​Utilisation

​Détails du job

Authorizations

Path Parameters

Response

Utilisation

Détails du job