AI_AGENT_MARKETPLACE Document

# AI Agent Marketplace API Document

AI Agent Marketplace is python/node packages to allow you to get access to AI Agent Card or Meta Information from open marketplace of various endpoints.
It can be easily integrated in your LLM and AI application workflow, including Get, LIST, UPDATE , CREATE and DELETE method, which can also give
user reviews, ratings and github stars and many metrics to allow LLM to choose wisely.

# [API V2](#get_method)

## 1. GET Agent Card Meta
GET MCP Marketplace Server Meta Information
```http
GET /api/ai_agent_marketplace/v2?mode=list&query=coding agent&page_id=0&count_per_page=5
```

**Curl**
```http
curl 'http://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=list&query=coding agent&page_id=0&count_per_page=5'
```

**Parameters**

| Parameter      | type   | value                                                   |
|----------------|--------|---------------------------------------------------------|
| query          | string | /api/ai_agent_marketplace/v2?query=map                  |
| category       | string | /api/ai_agent_marketplace/v2?category=map               |
| -              | string   | /api/ai_agent_marketplace/v2?                           |
| page_id        | int    | /api/ai_agent_marketplace/v2?page_id=0&count_per_page=5 |
| count_per_page | int    | /api/ai_agent_marketplace/v2?page_id=0&count_per_page=5 |
| offset         | int    | /api/ai_agent_marketplace/v2?offset=0                   |
| mode           | string    | mode='list' or 'dict'                                   |

**Results**

| Parameter     | type   | value                                                                                  |
|---------------|--------|----------------------------------------------------------------------------------------|
| total_hits    | int    | total hits of items                                                                    |
| count         | int    | the cound of items returned in this page, etc.                                         |
| items         | string | the list of json object returned                                                       |
| $.id          | string | ID of AI Agent, format as {owner_id}/{content_name},e.g. 'demo-publisher/auto-agent-1' |
| $.publisher_id | string | the owner_id of the AI Agent published with prefix 'pub-'                              |
| $.content_name | string | the name of AI Agent                                                                   |
| $.website      | string | URL of AI Agent                                                                        |
| $.review_cnt   | int    | number of user reviews                                                                 |
| $.rating       | double | rating of reviews 0.0-5.0                                                              |
| $.description  | string | description of the AI Agent                                                            |

```
{
"query":"coding agent",
"items":[
{"content_name":"AI Agent 1","publisher_id":"pub-user-agent-v1","website":"","subfield":"Coding Agent","field":"AI Agent","description":"","id":"user-agent-v1/ai-agent-28"},
{"content_name":"AI Agent 2","publisher_id":"pub-user-agent-v1","website":"","subfield":"Coding Agent","field":"AI Agent","description":"","id":"user-agent-v1/ai-agent-28"},
],
"total_hits":50,"count":5,
}
```

###  [List Mode](#return_list)

#### Get By Unique ID

The uniqune IDs usually follows the github or nodejs schema, such as unique_id="{username}/{reponame}"

```http
GET /api/ai_agent_marketplace/v2?mode=list&id=pub-user-agent-v1/ai-agent-28
```

#### Get Search Query
```http
GET /api/ai_agent_marketplace/v2?mode=list&query=coding agent&page_id=0&count_per_page=5
```

#### Pagination

```http
GET /api/ai_agent_marketplace/v2?mode=list&query=coding agent&page_id=0&count_per_page=5
```

| Parameter      | type   | value                                   |
|----------------|--------|-----------------------------------------|
| page_id        | int    | current id of page                      |
| count_per_page | int    | default count of items per page.        |
| offset         | int    | number of items to skip, equivalent to page_id * count_per_page |

# [API V1](#get_method)
```http
GET /api/ai_agent_marketplace/v1?q=coding agent&limit=20

```

**Curl**
```http
curl 'http://www.deepnlp.org/api/ai_agent_marketplace/v1?q=coding agent&limit=20'
'
```

**Parameters**

| Parameter     | type   | value                                  |
|---------------|--------|----------------------------------------|
| q             | string | /api/ai_agent_marketplace/v1?query=map |
| return_fields              | string | /api/ai_agent_marketplace/v1?q=coding agent&limit=20&return_fields=statistic
| category       | string | /api/ai_agent_marketplace/v1?category=coding agent   |
| list           | string   | /api/ai_agent_marketplace/v1?               |
| limit          | int    | 5                                      |
| mode           | string    | mode='list' or 'dict'                  |

**Results**
```
{
"items":[{"content_name":"AI Agent 28","publisher_id":"pub-user-agent-v1","review_cnt":0,"statistic":{},"subfield":"Coding Agent","field":"AI Agent","rating":"0.0","description":"My AI Agent can solve math problem","content_tag_list":"AI AGENT"},{"content_name":"AI Agent 27","publisher_id":"pub-user-agent-v1","review_cnt":0,"statistic":{},"subfield":"Coding Agent","field":"AI Agent","rating":"0.0","description":"My AI Agent can solve math problem","content_tag_list":"AI AGENT"},{"content_name":"AI Agent 25","publisher_id":"pub-user-agent-v1","review_cnt":0,"statistic":{},"subfield":"Coding Agent","field":"AI Agent","rating":"0.0","description":"My AI Agent can solve math problem","content_tag_list":"AI AGENT"}],
"sub_category":"",
"limit":1000,
"category":"ai agent"
}

```