API Reference

Create an AI agent run

post
https://api.heymantle.com/v1/ai/agents//runs

Trigger an AI agent query. The run is executed asynchronously in the background.

Returns immediately with a run object in "pending" status. Poll the GET /ai/agents/{agentId}/runs/{runId} endpoint to check status and retrieve results.

The agentId parameter can be either the agent's UUID or its handle.

Agent runs are rate-limited to 10 requests per minute per organization (configurable via AGENT_API_RATE_LIMIT_PER_MINUTE environment variable).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The agent ID (UUID) or handle

Body Params
string
required

The prompt/query to send to the agent

uri

Optional URL of the source image to edit. When provided, the agent will use this as the base image for editing operations (e.g., remove background, add text, resize). The agent can see this image and will use its URL when calling image editing tools.

imageUrls
array of uris

Optional array of reference image URLs for style guidance. These images are shown to the agent for visual context but are not the source for editing. Use sourceImageUrl for the image to edit.

imageUrls
outputSchema
object

Optional JSON schema for structured response extraction. If provided, the agent's response will be parsed and extracted according to this schema.

options
object

Optional execution options

Responses

Updated about 2 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago