Send follow-up message
POST
/
v2
/
agent
/
/
job
/
/
message
Send follow-up message
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": "https://github.com/org/repo/pull/123",
"createdAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Send a follow-up instruction to an existing agent job. The agent processes the message asynchronously. Poll the get agent job endpoint to track progress.
Rate limits
Section titled “Rate limits”- 100 uses per Mintlify project per hour
curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \
-H "Authorization: Bearer mint_xxxxx" \
-H "Content-Type: application/json" \
-d '{"prompt": "Also add error handling examples to the quickstart guide"}'Authorizations
Section titled “Authorizations”Authorization
string
header
required
The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.
Path Parameters
Section titled “Path Parameters”projectId
string
required
Your project ID. Can be copied from the API keys page in your dashboard.
id
string
required
The unique identifier of the agent job to send a message to.
application/json
prompt
string
required
The follow-up instruction for the agent.
Minimum string length: 1
Response
Section titled “Response”Message sent successfully
id
string
Unique identifier for the agent job.
status
enum<string>
Current status of the job. active — the agent is currently processing the prompt. completed — the agent finished successfully and a PR may have been created (check prLink). archived — the job has been archived. failed — the agent encountered an unrecoverable error. Poll until status is completed, archived, or failed.
Available options:
active,
completed,
archived,
failed
source
object
Source repository information.
Show child attributes
model
string
The AI model used for this job.
prLink
string<uri> | null
GitHub pull request URL created by the agent. null while the job is still active or if no files were changed. Populated once the agent successfully creates a PR.
Example:
"https://github.com/org/repo/pull/123"
createdAt
string<date-time>
Timestamp when the job was created.
archivedAt
string<date-time> | null
Timestamp when the job was archived.
⌘I