Agent Runs

Iniciar una ejecución de agente guardada

Inicia una ejecución en segundo plano asíncrona para un agente guardado y devuelve el registro de ejecución en cola. Usa el endpoint de recuperación de ejecuciones para consultar el estado o el endpoint de eventos para transmitir el progreso. Cuando el agente ya está ejecutando el máximo de max_concurrent_runs ejecuciones, concurrency_overflow decide: reject devuelve 429 con el código de error agent_concurrency_limit y no crea ninguna ejecución; queue devuelve 202 con una ejecución en espera que comienza cuando se libera un cupo.

POST

api

agents

{agent_id}

runs

Typescript (SDK)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.agentRuns.createAgentRun({
    agentId: "<id>",
    createAgentRunRequest: {
      input: [
        {
          type: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

package main

import(
	"context"
	mka1 "github.com/MeetKai/mka1-sdks/go"
	"github.com/MeetKai/mka1-sdks/go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := mka1.New(
        mka1.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    res, err := s.AgentRuns.CreateAgentRun(ctx, "<id>", components.CreateAgentRunRequest{
        Input: components.CreateCreateAgentRunRequestInputUnionArrayOfCreateAgentRunRequestInput(
            []components.CreateAgentRunRequestInput{
                components.CreateAgentRunRequestInput{},
            },
        ),
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.AgentRun != nil {
        // handle response
    }
}

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;
using System.Collections.Generic;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.AgentRuns.CreateAgentRunAsync(
    agentId: "<id>",
    body: new MeetKai.MKA1.Types.Components.CreateAgentRunRequest() {
        Input = CreateAgentRunRequestInputUnion.CreateArrayOfCreateAgentRunRequestInput(
            new List<CreateAgentRunRequestInput>() {
                new CreateAgentRunRequestInput() {
                    Type = "<value>",
                },
            }
        ),
    }
);

// handle response

from meetkai_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>",
        ),
    ], stream=False)

    # Handle response
    print(res)

curl --request POST \
  --url https://apigw.mka1.com/api/v1/agents/{agent_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "idempotency_key": "<string>",
  "agent_version": 1073741824,
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "context_management": [
    {
      "type": "compaction",
      "compact_threshold": 1001
    }
  ],
  "stream": false,
  "metadata": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input: '<string>',
    idempotency_key: '<string>',
    agent_version: 1073741824,
    conversation: '<unknown>',
    previous_response_id: '<string>',
    context_management: [{type: 'compaction', compact_threshold: 1001}],
    stream: false,
    metadata: {}
  })
};

fetch('https://apigw.mka1.com/api/v1/agents/{agent_id}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/agents/{agent_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => '<string>',
    'idempotency_key' => '<string>',
    'agent_version' => 1073741824,
    'conversation' => '<unknown>',
    'previous_response_id' => '<string>',
    'context_management' => [
        [
                'type' => 'compaction',
                'compact_threshold' => 1001
        ]
    ],
    'stream' => false,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/agents/{agent_id}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"agent_version\": 1073741824,\n  \"conversation\": \"<unknown>\",\n  \"previous_response_id\": \"<string>\",\n  \"context_management\": [\n    {\n      \"type\": \"compaction\",\n      \"compact_threshold\": 1001\n    }\n  ],\n  \"stream\": false,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/agents/{agent_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"agent_version\": 1073741824,\n  \"conversation\": \"<unknown>\",\n  \"previous_response_id\": \"<string>\",\n  \"context_management\": [\n    {\n      \"type\": \"compaction\",\n      \"compact_threshold\": 1001\n    }\n  ],\n  \"stream\": false,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "object": "agent.run",
  "id": "<string>",
  "agent_id": "<string>",
  "agent_version": 2,
  "status": "waiting",
  "input": "<unknown>",
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "metadata": {},
  "gateway_response_id": "<string>",
  "gateway_response": "<unknown>",
  "error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "object": "agent.run",
  "id": "<string>",
  "agent_id": "<string>",
  "agent_version": 2,
  "status": "waiting",
  "input": "<unknown>",
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "metadata": {},
  "gateway_response_id": "<string>",
  "gateway_response": "<unknown>",
  "error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

Autorizaciones

Authorization

string

header

requerido

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Encabezados

X-On-Behalf-Of

string

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

Parámetros de ruta

agent_id

string

requerido

Cuerpo

application/json

input

requerido

Required string length: 1 - 20000

idempotency_key

string

Clave de ámbito del llamador para reintentar el mismo envío sin iniciar otra ejecución. Reutilizar una clave con una solicitud diferente devuelve 409.

Required string length: 1 - 255

agent_version

integer

Versión de configuración del agente guardada inmutable para ejecutar. Omítala para usar la versión actual. Las versiones explícitas permanecen fijadas mientras están en cola.

Rango requerido: 1 <= x <= 2147483647

conversation

any

Valor JSON arbitrario.

previous_response_id

string

context_management

object[]

Estrategias de gestión del contexto a aplicar durante la generación de respuestas por el agente. Soporta la compactación, que resume el historial de conversación anterior cuando el contexto excede un umbral de tokens.

Show child attributes

stream

boolean

predeterminado:false

Cuando es true, la pasarela genera eventos delta por token para esta ejecución, de modo que el endpoint de eventos transmite salida incremental en lugar de solo elementos y límites de ciclo de vida. La ejecución sigue ejecutándose en segundo plano y este endpoint sigue devolviendo el registro de ejecución en cola.

metadata

object

Show child attributes

Respuesta

Ejecución en cola.

object

enum<string>

requerido

Opciones disponibles:

agent.run

string

requerido

agent_id

string

requerido

agent_version

integer | null

requerido

La versión de configuración del agente contra la que se ejecutó esta ejecución. Nulo para ejecuciones creadas antes de la versionación.

Rango requerido: x >= 1

status

enum<string>

requerido

esperando significa que la ejecución se mantiene en una de las ranuras max_concurrent_runs del agente y no se ha enviado al modelo; puede cancelarse. Los resultados terminales siguen siendo distintos: cancelado es solicitado por el llamador; incompleto significa que un límite o una interrupción detuvo la ejecución. gateway_response.incomplete_details registra el motivo, incluidos max_tokens o max_tool_calls. Las filas fallidas almacenadas con uno de estos resultados de gateway se serializan con el resultado de gateway, conservando cualquier error del conector y la marca de tiempo de finalización.

Opciones disponibles:

waiting,

queued,

submitting,

completed,

failed,

cancelled,

incomplete

input

any

requerido

Valor JSON arbitrario.

conversation

any | null

requerido

Valor JSON arbitrario.

previous_response_id

string | null

requerido

metadata

object | null

requerido

Show child attributes

gateway_response_id

string | null

requerido

gateway_response

any | null

requerido

Valor JSON arbitrario.

error

any | null

requerido

Valor JSON arbitrario.

created_at

string<date-time>

requerido

completed_at

string<date-time> | null

requerido

⌘I

Typescript (SDK)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.agentRuns.createAgentRun({
    agentId: "<id>",
    createAgentRunRequest: {
      input: [
        {
          type: "<value>",
        },
      ],
    },
  });

  console.log(result);
}

run();

package main

import(
	"context"
	mka1 "github.com/MeetKai/mka1-sdks/go"
	"github.com/MeetKai/mka1-sdks/go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := mka1.New(
        mka1.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    res, err := s.AgentRuns.CreateAgentRun(ctx, "<id>", components.CreateAgentRunRequest{
        Input: components.CreateCreateAgentRunRequestInputUnionArrayOfCreateAgentRunRequestInput(
            []components.CreateAgentRunRequestInput{
                components.CreateAgentRunRequestInput{},
            },
        ),
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.AgentRun != nil {
        // handle response
    }
}

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;
using System.Collections.Generic;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.AgentRuns.CreateAgentRunAsync(
    agentId: "<id>",
    body: new MeetKai.MKA1.Types.Components.CreateAgentRunRequest() {
        Input = CreateAgentRunRequestInputUnion.CreateArrayOfCreateAgentRunRequestInput(
            new List<CreateAgentRunRequestInput>() {
                new CreateAgentRunRequestInput() {
                    Type = "<value>",
                },
            }
        ),
    }
);

// handle response

from meetkai_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>",
        ),
    ], stream=False)

    # Handle response
    print(res)

curl --request POST \
  --url https://apigw.mka1.com/api/v1/agents/{agent_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "idempotency_key": "<string>",
  "agent_version": 1073741824,
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "context_management": [
    {
      "type": "compaction",
      "compact_threshold": 1001
    }
  ],
  "stream": false,
  "metadata": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input: '<string>',
    idempotency_key: '<string>',
    agent_version: 1073741824,
    conversation: '<unknown>',
    previous_response_id: '<string>',
    context_management: [{type: 'compaction', compact_threshold: 1001}],
    stream: false,
    metadata: {}
  })
};

fetch('https://apigw.mka1.com/api/v1/agents/{agent_id}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/agents/{agent_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => '<string>',
    'idempotency_key' => '<string>',
    'agent_version' => 1073741824,
    'conversation' => '<unknown>',
    'previous_response_id' => '<string>',
    'context_management' => [
        [
                'type' => 'compaction',
                'compact_threshold' => 1001
        ]
    ],
    'stream' => false,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/agents/{agent_id}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"agent_version\": 1073741824,\n  \"conversation\": \"<unknown>\",\n  \"previous_response_id\": \"<string>\",\n  \"context_management\": [\n    {\n      \"type\": \"compaction\",\n      \"compact_threshold\": 1001\n    }\n  ],\n  \"stream\": false,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/agents/{agent_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"agent_version\": 1073741824,\n  \"conversation\": \"<unknown>\",\n  \"previous_response_id\": \"<string>\",\n  \"context_management\": [\n    {\n      \"type\": \"compaction\",\n      \"compact_threshold\": 1001\n    }\n  ],\n  \"stream\": false,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "object": "agent.run",
  "id": "<string>",
  "agent_id": "<string>",
  "agent_version": 2,
  "status": "waiting",
  "input": "<unknown>",
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "metadata": {},
  "gateway_response_id": "<string>",
  "gateway_response": "<unknown>",
  "error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "object": "agent.run",
  "id": "<string>",
  "agent_id": "<string>",
  "agent_version": 2,
  "status": "waiting",
  "input": "<unknown>",
  "conversation": "<unknown>",
  "previous_response_id": "<string>",
  "metadata": {},
  "gateway_response_id": "<string>",
  "gateway_response": "<unknown>",
  "error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

Responses and conversations

Models and routing

Images and audio

Files and retrieval

Agents

Tools and sandbox

Evals and feedback

Compute

Repositories

Dataset generations

Organizations and access

Usage and budgets

Application utilities

Analytics

Legacy APIs

Additional APIs

Iniciar una ejecución de agente guardada

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta