Start a saved agent run

Starts an asynchronous background run for a saved agent and returns the queued run record. Use the run retrieval endpoint to poll status or the events endpoint to stream progress.

POST /api/v1/agents/{agent_id}/runs

Python (SDK)

Python

from mka1 import SDK, models


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.agent_runs.create_agent_run(agent_id="<id>", input=[
        models.CreateAgentRunRequestInput(
            type="<value>",
        ),
    ])

    # Handle response
    print(res)

201

{
  "id": "<string>",
  "agent_id": "<string>",
  "input": "<string>",
  "conversation": "<string>",
  "previous_response_id": "<string>",
  "metadata": {},
  "gateway_response_id": "<string>",
  "gateway_response": "<string>",
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Headers

X-On-Behalf-Of · string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

agent_id · string · required

Body

application/json

input · string object[] · required

Required string length: 1 - 20000

conversation · string number integer boolean any[] object

previous_response_id · string

metadata · object

Show child attributes

Response

201

application/json

Queued run.

object · enum<string> · required

Available options: agent.run

id · string · required

agent_id · string · required

status · enum<string> · required

Available options: queued, completed, failed

input · string number integer boolean any[] object · required

conversation · string number integer boolean any[] object · required

previous_response_id · string | null · required

metadata · object · required

Show child attributes

gateway_response_id · string | null · required

gateway_response · string number integer boolean any[] object · required

error · string number integer boolean any[] object · required

created_at · string<date-time> · required

completed_at · string<date-time> | null · required