Skip to content
Open
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions api/agent/create-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
openapi: POST /agent/{projectId}/job
keywords: ["agent job", "create", "automation", "automate"]
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').

## Rate limits

Expand Down
4 changes: 2 additions & 2 deletions api/agent/get-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
openapi: GET /agent/{projectId}/job/{id}
keywords: ["agent job", "status", "retrieve", "details"]
openapi: /admin-openapi.json GET /agent/{projectId}/job/{id}

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

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

Use 'administrator' instead of 'admin'.
keywords: [ "agent job", "status", "retrieve", "details" ]
---

## Usage
Expand Down
4 changes: 2 additions & 2 deletions api/agent/get-all-jobs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
openapi: GET /agent/{projectId}/jobs
keywords: ["agent jobs", "list", "monitoring"]
openapi: /admin-openapi.json GET /agent/{projectId}/jobs

Check warning on line 2 in api/agent/get-all-jobs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/get-all-jobs.mdx#L2

Use 'administrator' instead of 'admin'.
keywords: [ "agent jobs", "list", "monitoring" ]
---

## Usage
Expand Down
4 changes: 2 additions & 2 deletions api/assistant/create-assistant-message.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
openapi: POST /assistant/{domain}/message
keywords: ["assistant message", "embed", "chat", "integrate"]
openapi: /discovery-openapi.json POST /assistant/{domain}/message
keywords: [ "assistant message", "embed", "chat", "integrate" ]
---

## Integration with `useChat`

The `useChat` hook from Vercel's AI SDK is the recommended way to integrate the assistant API into your application.

Check warning on line 8 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L8

Use 'app' instead of 'application'.

<Note>
The Mintlify assistant API is compatible with **AI SDK v4**. If you use AI SDK v5 or later, you must configure a custom transport.
Expand Down Expand Up @@ -58,8 +58,8 @@
**Required configuration for Mintlify:**
- `streamProtocol: 'data'` - Required for streaming responses.
- `sendExtraMessageFields: true` - Required to send message metadata.
- `body.fp` - Fingerprint identifier (use 'anonymous' or a user identifier).

Check warning on line 61 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L61

Use parentheses judiciously.
- `body.retrievalPageSize` - Number of search results to use (recommended: 5).

Check warning on line 62 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L62

Use parentheses judiciously.

</Step>
</Steps>
Expand Down
4 changes: 2 additions & 2 deletions api/assistant/search.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: "POST /search/{domain}"
keywords: ["search", "query"]
openapi: "/discovery-openapi.json POST /search/{domain}"
keywords: [ "search", "query" ]
---
4 changes: 2 additions & 2 deletions api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: "GET /project/update-status/{statusId}"
keywords: ["update status", "deployment status", "check status"]
openapi: "/openapi.json GET /project/update-status/{statusId}"
keywords: [ "update status", "deployment status", "check status" ]
---
4 changes: 2 additions & 2 deletions api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: "POST /project/update/{projectId}"
keywords: ["trigger", "update", "deployment", "programmatic"]
openapi: "/openapi.json POST /project/update/{projectId}"
keywords: [ "trigger", "update", "deployment", "programmatic" ]
---
Loading