Skip to main content
POST
/
v1
/
agent
/
{projectId}
/
job
Crear trabajo del agente (v1)
curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "branch": "<string>",
  "asDraft": false,
  "model": "sonnet"
}
'
import requests

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

payload = {
    "messages": [{ "content": "<string>" }],
    "branch": "<string>",
    "asDraft": False,
    "model": "sonnet"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{content: '<string>'}],
    branch: '<string>',
    asDraft: false,
    model: 'sonnet'
  })
};

fetch('https://api.mintlify.com/v1/agent/{projectId}/job', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'content' => '<string>'
        ]
    ],
    'branch' => '<string>',
    'asDraft' => false,
    'model' => 'sonnet'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"branch\": \"<string>\",\n  \"asDraft\": false,\n  \"model\": \"sonnet\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.mintlify.com/v1/agent/{projectId}/job")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"branch\": \"<string>\",\n  \"asDraft\": false,\n  \"model\": \"sonnet\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"branch\": \"<string>\",\n  \"asDraft\": false,\n  \"model\": \"sonnet\"\n}"

response = http.request(request)
puts response.read_body
"<string>"
Este endpoint está en desuso. Usa el endpoint crear trabajo del agente v2 en su lugar.
Este endpoint crea un trabajo del agente a partir de los mensajes proporcionados y la información de la branch. El trabajo se ejecuta de forma asíncrona y devuelve una respuesta en streaming con los detalles de la ejecución y los resultados. Si no existe una branch, el agente crea una. Si el agente edita los archivos correctamente, crea automáticamente una solicitud de extracción al finalizar el trabajo.

​
Límites de tasa

La API del agente tiene los siguientes límites:
  • 100 usos por proyecto de Mintlify por hora

​
Uso recomendado

Para obtener mejores resultados, utiliza el hook useChat de ai-sdk para enviar solicitudes y gestionar las respuestas.

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. Se puede copiar desde la página de API keys en tu dashboard.

Body

application/json
​
messages
object[]
required

Una lista de mensajes para proporcionar al agente. Siempre se antepone automáticamente un prompt del sistema predeterminado, por lo que normalmente solo necesitas incluir mensajes del usuario.

​
branch
string

El nombre de la branch de Git en la que debe trabajar el agente. Si se omite, el agente genera un nombre de branch a partir del contenido del mensaje.

​
asDraft
boolean
default:false

Controla si la solicitud de extracción se crea en modo borrador o en modo normal. Cuando es true, crea una solicitud de extracción en borrador. Cuando es false (predeterminado), crea una solicitud de extracción regular lista para revisión.

​
model
enum<string>
default:sonnet

El modelo de IA que se usará para el trabajo del agente. Usa sonnet para un procesamiento más rápido y rentable. Usa opus para un procesamiento más capaz, pero más lento.

Available options:
sonnet,
opus

Response

200 - text/event-stream

Tarea de agente creada correctamente. Devuelve una respuesta en streaming con Server-Sent Events.

Flujo Server-Sent Events que contiene los detalles de ejecución y resultados de la tarea de agente.

Related topics

Vista general de automatizacionesskill.mdVisibility