Passer au contenu principal
POST
/
agent
/
{projectId}
/
job
/
{id}
/
message
Send message to agent job
curl --request POST \
  --url https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>"
}
'
{
  "id": "<string>",
  "status": "active",
  "source": {
    "repository": "<string>",
    "ref": "<string>"
  },
  "model": "<string>",
  "prLink": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}
Cet endpoint envoie un message supplémentaire à une session de tâche agent existante. Utilisez-le pour continuer une conversation avec l’agent, fournir des clarifications ou demander des modifications supplémentaires.

​
Quand utiliser

  • Demander des modifications de documentation supplémentaires après la tâche initiale
  • Fournir des clarifications ou corrections à l’agent
  • Poser des questions de suivi sur les modifications effectuées
  • Demander des modifications à un brouillon de pull request

​
Notes d’utilisation

  • L’agent traite le message en arrière-plan
  • Interrogez l’endpoint Obtenir une tâche agent pour voir le statut mis à jour
  • La session doit être active pour recevoir des messages
  • L’envoi d’un message à une tâche completed ou failed renvoie une erreur

Autorisations

​
Authorization
string
header
requis

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.

Paramètres de chemin

​
projectId
string
requis

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

​
id
string
requis

The unique identifier of the agent job to send a message to.

Corps

application/json
​
prompt
string
requis

The message content to send to the agent.

Réponse

Message sent successfully. The agent processes it in the background.

​
id
string

Unique identifier for the agent job.

​
status
enum<string>

Current status of the agent job.

Options disponibles:
active,
completed,
archived,
failed
​
source
object

Information about the source repository.

​
model
string

The AI model used for this job.

​
prLink
string | null

URL of the pull request created by the agent. Null until the PR is created.

​
createdAt
string<date-time>

Timestamp when the job was created.

​
archivedAt
string<date-time> | null

Timestamp when the job was archived. Null if still active.