Merge branch 'main' of github.com:jzanecook/agent-protocol

AI-Engineer-Foundation · Sep 20, 2023 · b19650e · b19650e
2 parents 7b77316 + 9c63b4c
commit b19650e
Show file tree

Hide file tree

Showing 48 changed files with 215 additions and 7,343 deletions.
diff --git a/.github/workflows/js-sdk-lint.yaml b/.github/workflows/js-sdk-lint.yaml
diff --git a/.github/workflows/js-sdk-publish.yaml b/.github/workflows/js-sdk-publish.yaml
diff --git a/.github/workflows/python-sdk-publish.yaml b/.github/workflows/python-sdk-publish.yaml
diff --git a/README.md b/README.md
@@ -67,9 +67,9 @@ Right now the protocol is defined as a REST API (via the
 [OpenAPI spec](./schemas/openapi.yml)) with two essential routes for interaction with
 your agent:
 
-- `POST /agent/tasks` for creating a new task for the agent (for example giving
+- `POST /ap/v1/agent/tasks` for creating a new task for the agent (for example giving
  the agent an objective that you want to accomplish)
-- `POST /agent/tasks/{task_id}/steps` for executing one step of the defined task
+- `POST /ap/v1/agent/tasks/{task_id}/steps` for executing one step of the defined task
 
 It has also a few additional routes for listing the tasks, steps and downloading / uploading artifacts.
 

diff --git a/client/python/agent_protocol_client/api/agent_api.py b/client/python/agent_protocol_client/api/agent_api.py
@@ -203,7 +203,7 @@ def create_agent_task_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks",
+ "/ap/v1/agent/tasks",
  "POST",
  _path_params,
  _query_params,
@@ -383,7 +383,7 @@ def download_agent_task_artifact_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/artifacts/{artifact_id}",
+ "/ap/v1/agent/tasks/{task_id}/artifacts/{artifact_id}",
  "GET",
  _path_params,
  _query_params,
@@ -571,7 +571,7 @@ def execute_agent_task_step_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/steps",
+ "/ap/v1/agent/tasks/{task_id}/steps",
  "POST",
  _path_params,
  _query_params,
@@ -738,7 +738,7 @@ def get_agent_task_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}",
+ "/ap/v1/agent/tasks/{task_id}",
  "GET",
  _path_params,
  _query_params,
@@ -918,7 +918,7 @@ def get_agent_task_step_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/steps/{step_id}",
+ "/ap/v1/agent/tasks/{task_id}/steps/{step_id}",
  "GET",
  _path_params,
  _query_params,
@@ -1087,7 +1087,7 @@ def list_agent_task_artifacts_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/artifacts",
+ "/ap/v1/agent/tasks/{task_id}/artifacts",
  "GET",
  _path_params,
  _query_params,
@@ -1256,7 +1256,7 @@ def list_agent_task_steps_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/steps",
+ "/ap/v1/agent/tasks/{task_id}/steps",
  "GET",
  _path_params,
  _query_params,
@@ -1405,7 +1405,7 @@ def list_agent_tasks_ids_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks",
+ "/ap/v1/agent/tasks",
  "GET",
  _path_params,
  _query_params,
@@ -1632,7 +1632,7 @@ def upload_agent_task_artifacts_with_http_info(
  }
 
  return self.api_client.call_api(
- "/agent/tasks/{task_id}/artifacts",
+ "/ap/v1/agent/tasks/{task_id}/artifacts",
  "POST",
  _path_params,
  _query_params,

diff --git a/client/python/agent_protocol_client/docs/AgentApi.md b/client/python/agent_protocol_client/docs/AgentApi.md
@@ -4,15 +4,15 @@ All URIs are relative to _http://localhost_
 
 | Method | HTTP request | Description |
 | ---------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------- |
-| [**create_agent_task**](AgentApi.md#create_agent_task) | **POST** /agent/tasks | Creates a task for the agent. |
-| [**download_agent_task_artifact**](AgentApi.md#download_agent_task_artifact) | **GET** /agent/tasks/{task_id}/artifacts/{artifact_id} | Download a specified artifact. |
-| [**execute_agent_task_step**](AgentApi.md#execute_agent_task_step) | **POST** /agent/tasks/{task_id}/steps | Execute a step in the specified agent task. |
-| [**get_agent_task**](AgentApi.md#get_agent_task) | **GET** /agent/tasks/{task_id} | Get details about a specified agent task. |
-| [**get_agent_task_step**](AgentApi.md#get_agent_task_step) | **GET** /agent/tasks/{task_id}/steps/{step_id} | Get details about a specified task step. |
-| [**list_agent_task_artifacts**](AgentApi.md#list_agent_task_artifacts) | **GET** /agent/tasks/{task_id}/artifacts | List all artifacts that have been created for the given task. |
-| [**list_agent_task_steps**](AgentApi.md#list_agent_task_steps) | **GET** /agent/tasks/{task_id}/steps | List all steps for the specified task. |
-| [**list_agent_tasks_ids**](AgentApi.md#list_agent_tasks_ids) | **GET** /agent/tasks | List all tasks that have been created for the agent. |
-| [**upload_agent_task_artifacts**](AgentApi.md#upload_agent_task_artifacts) | **POST** /agent/tasks/{task_id}/artifacts | Upload an artifact for the specified task. |
+| [**create_agent_task**](AgentApi.md#create_agent_task) | **POST** /ap/v1/agent/tasks | Creates a task for the agent. |
+| [**download_agent_task_artifact**](AgentApi.md#download_agent_task_artifact) | **GET** /ap/v1/agent/tasks/{task_id}/artifacts/{artifact_id} | Download a specified artifact. |
+| [**execute_agent_task_step**](AgentApi.md#execute_agent_task_step) | **POST** /ap/v1/agent/tasks/{task_id}/steps | Execute a step in the specified agent task. |
+| [**get_agent_task**](AgentApi.md#get_agent_task) | **GET** /ap/v1/agent/tasks/{task_id} | Get details about a specified agent task. |
+| [**get_agent_task_step**](AgentApi.md#get_agent_task_step) | **GET** /ap/v1/agent/tasks/{task_id}/steps/{step_id} | Get details about a specified task step. |
+| [**list_agent_task_artifacts**](AgentApi.md#list_agent_task_artifacts) | **GET** /ap/v1/agent/tasks/{task_id}/artifacts | List all artifacts that have been created for the given task. |
+| [**list_agent_task_steps**](AgentApi.md#list_agent_task_steps) | **GET** /ap/v1/agent/tasks/{task_id}/steps | List all steps for the specified task. |
+| [**list_agent_tasks_ids**](AgentApi.md#list_agent_tasks_ids) | **GET** /ap/v1/agent/tasks | List all tasks that have been created for the agent. |
+| [**upload_agent_task_artifacts**](AgentApi.md#upload_agent_task_artifacts) | **POST** /ap/v1/agent/tasks/{task_id}/artifacts | Upload an artifact for the specified task. |
 
 # **create_agent_task**
 

diff --git a/docs/src/app/clients/others/page.mdx b/docs/src/app/clients/others/page.mdx
@@ -19,15 +19,15 @@ const url = 'http://localhost:8000'
 const body = JSON.stringify({ input: 'task-input-to-your-agent' })
 
 // Create task
-let response = await fetch(`${url}/agent/tasks`, { method: 'POST' }, { body })
+let response = await fetch(`${url}/ap/v1/agent/tasks`, { method: 'POST' }, { body })
 let data = await response.json()
 
 const taskId = data.task_id
 let isLast = false
 
 // Execute steps until the completion
 while (!isLast) {
- response = await fetch(`${url}/agent/tasks/${taskId}/steps`, {
+ response = await fetch(`${url}/ap/v1/agent/tasks/${taskId}/steps`, {
  method: 'POST',
  })
  data = await response.json()
@@ -46,7 +46,7 @@ To **create a task** run
 
 ```sh
 curl --request POST \
- --url http://localhost:8000/agent/tasks \
+ --url http://localhost:8000/ap/v1/agent/tasks \
  --header 'Content-Type: application/json' \
  --data '{
  "input": "task-input-to-your-agent"
@@ -68,7 +68,7 @@ previous request and run:
 
 ```sh
 curl --request POST \
- --url http://localhost:8000/agent/tasks/<task-id>/steps
+ --url http://localhost:8000/ap/v1/agent/tasks/<task-id>/steps
 ```
 
 To get response like this: