Skip to main content
POST
/
v1
/
agent
/
{projectId}
/
job
Create agent job (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"
}
'
"<string>"
This endpoint is deprecated. Use the v2 create agent job endpoint instead.
This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results. If a branch doesn’t exist, the agent creates one. If the agent edits files successfully, it automatically creates a pull request at the end of the job.

​
Rate limits

The agent API has the following limits:
  • 100 uses per Mintlify project per hour

​
Suggested usage

For best results, use the useChat hook from ai-sdk to send requests and handle responses.

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
projectId
string
required

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

Body

application/json
​
messages
object[]
required

A list of messages to provide to the agent. A default system prompt is always prepended automatically, so you typically only need to include user messages.

​
branch
string

The name of the Git branch that the agent should work on. If omitted, the agent generates a branch name based on the message content.

​
asDraft
boolean
default:false

Control whether the pull request is created in draft or non-draft mode. When true, creates a draft pull request. When false (default), creates a regular pull request ready for review.

​
model
enum<string>
default:sonnet

The AI model to use for the agent job. Use sonnet for faster, cost-effective processing. Use opus for more capable, but slower processing.

Available options:
sonnet,
opus

Response

200 - text/event-stream

Agent job created successfully. Returns a streaming response with Server-Sent Events.

Server-Sent Events stream containing the agent job execution details and results.

Related topics

Create agent jobGet agent jobAsk agent