Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions api/agent/create-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
openapi: /admin-openapi.json POST /agent/{projectId}/job

Check warning on line 2 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L2

Use 'administrator' instead of 'admin'.
keywords: [ "agent job", "create", "automation", "automate" ]
---

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 files are edited successfully, a pull request is automatically created at the end of the job.

Check warning on line 8 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L8

In general, use active voice instead of passive voice ('are edited').

## Parameters

<ParamField body="model" type="string" default="sonnet">
The AI model to use for the agent job. Choose between `sonnet` (faster, cost-effective) or `opus` (more capable, higher quality).
</ParamField>

## Rate limits

The agent API has the following limits:
Expand Down