Obtener trabajo de agente (v1)

GET

agent

{projectId}

job

{id}

Obtener trabajo del agente por 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"
}

Este endpoint está en desuso. Usa en su lugar el endpoint v2 obtener trabajo de agente.

Uso

Este endpoint obtiene los detalles y el estado de un trabajo de agente específico mediante su identificador único. Úsalo para comprobar el progreso, el estado y los resultados de un trabajo de agente creado previamente.

Detalles del trabajo

La respuesta incluye información como:

Estado de ejecución del trabajo y estado de finalización
Información de la branch y detalles de la solicitud de extracción
metadata de la sesión y marcas de tiempo

Authorizations

Authorization

string

header

required

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genera una clave en la página de claves de API de tu dashboard.

Path Parameters

projectId

string

required

El ID de tu proyecto. Puedes copiarlo desde la página de API keys en tu dashboard.

string

required

El identificador único del trabajo del agente que se va a recuperar.

Response

200 - application/json

Detalles del trabajo del agente recuperados correctamente

sessionId

string

El subdomain al que pertenece esta sesión.

subdomain

string

El subdomain al que pertenece esta sesión.

branch

string | null

Nombre de la branch de Git en la que se realizaron los cambios.

haulted

boolean

Indica si se detuvo la ejecución de la sesión.

haultReason

enum<string>

Motivo de la interrupción de la sesión. processing indica que la tarea está en curso. interrupted indica que la tarea fue interrumpida manualmente.

Available options:

completed,

github_missconfigured,

error,

processing,

interrupted

pullRequestLink

string

Enlace a la solicitud de extracción creada.

messageToUser

string

Mensaje para el usuario sobre el resultado de la sesión.

todos

object[]

Lista de tareas pendientes de la sesión.

Show child attributes

userId

string

El ID del usuario que creó esta sesión, si está disponible.

title

string

Título generado que resume el trabajo del agente.

createdAt

string<date-time>

Marca de tiempo de creación de la sesión.

Obtener trabajo del agente por 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"
}

​Uso

​Detalles del trabajo

Authorizations

Path Parameters

Response

Uso

Detalles del trabajo