AI Agent Marketplace API Document

AI Agent Marketplace are python/node packages to support AI Agent registry, AI Agent search, AI Agent exploration by various categories. You can get access to AI Agent Meta Information from open marketplace of various endpoints. It can be easily integrated in your LLM and AI application workflow, including Get, POST, LIST, UPDATE method, which also supports user reviews, ratings and github stars and many metrics such as open OneKey routing usage to allow LLM to choose wisely.

API V2

AI Agent Marketplace Registry API, including get, search and more API endpoints. Please Visit Supported API Summary to see complete List.

QuickStart

GET

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

Curl

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

Parameters

Parameter	type	demo value	Description
query	string	/api/ai_agent_marketplace/v2?query=map	-
-	string	/api/ai_agent_marketplace/v2?	-
page_id	int	/api/ai_agent_marketplace/v2?page_id=0&count_per_page=5	starting from 0
count_per_page	int	/api/ai_agent_marketplace/v2?page_id=0&count_per_page=5	number of items per page
offset	int	/api/ai_agent_marketplace/v2?offset=0	total number offset, equals page_id*count_per_page
mode	string	mode=’list’ or ‘dict’	different output return type, list of 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’
$.detail_url	string	Detail URL Webpage of AI Agent Card
$.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

Json Result Demo

{
	"item_map": {
		"coding agent": [{
			"content_name": "Cursor AI",
			"publisher_id": "pub-cursor",
			"detail_url": "https://www.deepnlp.org/store/ai-agent/coding-agent/pub-cursor/cursor-ai",
			"website": "",
			"review_cnt": "3",
			"subfield": "Coding Agent",
			"field": "AI AGENT",
			"rating": "3.3",
			"description": "",
			"id": "cursor/cursor-ai",
			"thumbnail_picture": "https://static.aiagenta2z.com/scripts/img/ai_service_content/a7dd95e7eb419437ef4a91f4b0e853cb.jpg"
		}, {
			"content_name": "trae ai",
			"publisher_id": "pub-trae-ai",
			"detail_url": "https://www.deepnlp.org/store/ai-agent/coding-agent/pub-trae-ai/trae-ai",
			"website": "",
			"review_cnt": "2",
			"subfield": "Coding Agent",
			"field": "AI AGENT",
			"rating": "4.0",
			"description": "",
			"id": "trae-ai/trae-ai",
			"thumbnail_picture": "https://static.aiagenta2z.com/scripts/img/ai_service_content/cc43d2dc25488b50b883781e0ae8c988.png"
		}, {
			"content_name": "claude code",
			"publisher_id": "pub-anthropics",
			"detail_url": "https://www.deepnlp.org/store/ai-agent/coding-agent/pub-anthropics/claude-code",
			"website": "",
			"review_cnt": "2",
			"subfield": "Coding Agent",
			"field": "AI AGENT",
			"rating": "3.5",
			"description": "",
			"id": "anthropics/claude-code",
			"thumbnail_picture": "https://static.aiagenta2z.com/scripts/img/ai_service_content/ac31ac4698667fe9dabbb5f0115c1873.png"
		}, {
			"content_name": "fine dev",
			"publisher_id": "pub-fine-dev",
			"detail_url": "https://www.deepnlp.org/store/ai-agent/ai-agent/pub-fine-dev/fine-dev",
			"website": "",
			"review_cnt": "1",
			"subfield": "AI AGENT",
			"field": "AI AGENT",
			"rating": "4.0",
			"description": "",
			"id": "fine-dev/fine-dev",
			"thumbnail_picture": "https://www.fine.dev/_next/static/media/logo.76f79362.svg"
		}, {
			"content_name": "claude code",
			"publisher_id": "pub-claude-code",
			"detail_url": "https://www.deepnlp.org/store/ai-agent/coding-agent/pub-claude-code/claude-code",
			"website": "",
			"review_cnt": "1",
			"subfield": "Coding Agent",
			"field": "AI AGENT",
			"rating": "5.0",
			"description": "",
			"id": "claude-code/claude-code",
			"thumbnail_picture": "https://static.aiagenta2z.com/scripts/img/ai_service_content/7d6c735321396b42b5c2e46499e17a6e.png"
		}]
	},
	"page_id_map": {
		"coding agent": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60]
	},
	"query": "coding agent",
	"KEY_STORE_GROUP_CONTENT_URI_MAP": {
		"coding agent": "/store/ai-agent?tag\u003dcoding agent"
	},
	"group_cnt": {
		"coding agent": 5
	},
	"group_total": {
		"coding agent": 296
	}
}

Supported API Summary

Scenario	Mode	Endpoint	Description
Registry	Github or Huggingface URL	POST /api/ai_agent_marketplace/registry	Register your AI Agent with url containing unique id {owner_id}/{repo_id}, e.g. https://github.com/{owner_id}/{repo_id}
	Detailed Json of Meta	POST /api/ai_agent_marketplace/registry, POST /api/ai_agent_marketplace/v1 (@Depreciated)	You can register detailed AI Agent meta and use this endpoint and curl/python function, such as name, content, website, url, field (category) and tags, etc.
Search by Unique ID	MODE=LIST	GET /api/ai_agent_marketplace/v2?mode=list&id=google-maps/google-maps	-
	MODE=DICT	GET /api/ai_agent_marketplace/v2?mode=dict&id=google-maps/google-maps	-
Search by Query	MODE=LIST	GET /api/ai_agent_marketplace/v2?mode=list&page_id=0&count_per_page=20&query=coding%20agent	When you want to search ‘Coding Agent’ related AI Agents
	MODE=DICT	GET /api/ai_agent_marketplace/v2?mode=dict&page_id=0&count_per_page=20&query=coding%20agent	Suitable for Search By category name, such as ‘Coding Agent’
No Query, Pagination	MODE=LIST	GET /api/ai_agent_marketplace/v2?mode=list&page_id=0&count_per_page=20	Explore AI Agents with no query by various category, return a List
	MODE=DICT	GET /api/ai_agent_marketplace/v2?mode=dict&page_id=0&count_per_page=20	Explore AI Agents By various Category, return a Map key as category name

Registry of Your AI Agent

List of Methods that you can register your AI agent

method	usage
Website	Visit the official AI Agent registry
curl	Support to Submit your Github Repo contents to the marketplace
CLI	Command Line agtm upload --github or agtm upload --config ./agent.json
python	Install packages pip install ai-agent-marketplace
nodejs	Install packages npm install -g @aiagenta2z/agtm

Supported methods including curl, python, js and any programming languages that supports post methods you prefer. Please follow the input json keys and formats.

First of all, registration of AI Agents requires one access key to authenticate your account, please visit API KEY to get one for scene ‘ai_agent_marketplace_api’.

Curl Github URL

export AI_AGENT_MARKETPLACE_ACCESS_KEY="your_access_key"

## replace the key in the curl command 

curl -X POST https://www.deepnlp.org/api/ai_agent_marketplace/registry \
  -H "Content-Type: application/json" \
  -d '{"github":"https://github.com/microsoft/markitdown", "access_key":"{AI_AGENT_MARKETPLACE_ACCESS_KEY}"}'

Note: If you submit GitHub url based AI Agent meta, you can’t change the id of agent “${owner}/${repo}” in the AI Agent Index, to avoid infringement of code copyright. Your account on deepnlp.org need to be the same as the GitHub Login ${owner} to list and manage and all your repos’ information. And We reserve the right to revoke the GitHub URL submission method in case of misuse.

Command Line CLI

Install the command line using pip or nodejs first, Get access key at keys. See agtm GitHub for latest update.

export AI_AGENT_MARKETPLACE_ACCESS_KEY="{your_access_key}"
agtm upload --github https://github.com/AI-Hub-Admin/My-First-AI-Coding-Agent

## upload from json file or yaml file
agtm upload --config ./agent.json
agtm upload --config ./agent.yaml

Demo examples can be found in ./agent.json or ./agent.yaml

Setup Your Own Endpoint or Schema

Please visit the command line github package agtm detailed usage

agtm upload --config ./agent.json --endpoint https://www.example.com --schema ./schema.json

For test API Key, please set variable of AI_AGENT_MARKETPLACE_ACCESS_KEY. And your submission will be uploaded to a test account.

export AI_AGENT_MARKETPLACE_ACCESS_KEY="TEST_KEY_AI_AGENT_REGISTRY"

agtm upload --config ./agent.json --endpoint https://www.deepnlp.org/api/ai_agent_marketplace/registry --schema ./schema.json

# or 

agtm upload --config ./agent.json --endpoint https://www.aiagenta2z.com/api/ai_agent_marketplace/registry --schema ./schema.json

Python API

import json
import ai_agent_marketplace as aam

def register_ai_agent_from_github():
    """
        Register your AI Agent if you have open sourced on GitHub
        Access_key can be obtained from generation: https://deepnlp.org/workspace/keys

        Website : https://www.deepnlp.org/workspace/my_ai_services
        once you submit, it's pending approval and you can track the data then
        get your access_key from https://www.deepnlp.org/workspace/my_ai_services
    """
    access_key = "${your_access_key}"

    item_info = {}
    item_info["github"] = "https://github.com/AI-Hub-Admin/FinanceAgent"
    result = aam.add(item_info, access_key=access_key)
    print (f"## DEBUG: AI Agent Marketplace Post Result URL {result.get("url")} and message {result.get("msg")}")

def register_ai_agent_from_dict():
    """
        access_key can be obtained from your personal page:

        https://www.deepnlp.org/workspace/my_ai_services
        once you submit, it's pending approval and you can track the data then
        get your access_key from https://www.deepnlp.org/workspace/my_ai_services
    """
    access_key = "${your_access_key}"
    name = "My First AI Coding Agent"

    item_info = {}
    item_info["name"] = name
    item_info["content"] = "This AI Agent can do complicated programming work for humans"
    item_info["website"] = "https://www.my_first_agent.com"
    item_info["field"] = "AI AGENT"
    item_info["subfield"] = "Coding Agent"
    item_info["content_tag_list"] = "coding,python"

    result = aam.add(item_info, access_key=access_key)
    print (f"## DEBUG: AI Agent Marketplace Post url {result.get("url", "")} and message {result.get("msg", "")}")
    
register_ai_agent_from_github()

register_ai_agent_from_dict()

Registration Result

{"msg":"Thanks for your submission. You have registered successfully. Now It is still in pending status and please visit the url after logged in and wait for email notification of status change of approval","code":200,"url":"https://www.deepnlp.org/store/ai-agent/ai-agent/pub-microsoft/markitdown"}

Parameters

Parameter	Required	type	demo value	Description
.access_key	Required	string	AI_AGENT_MARKETPLACE_ACCESS_KEY=”your_access_key”	The access key you get from the website to authenticate your account as owner of the AI Agents
.name	Required	string	My First AI Coding Agent	-
.content	Required	string	This AI Agent can do complicated programming work for humans.	Support markdown of README.md, html and plain text format
.website	Optional	string	https://www.example.com
.field	Optional	string	AI Agent	Field denotes the first level category , Default to AI AGENT, you can use choose MCP Server,Video Generator,MODEL,DATASET,etc.
.subfield	Optional	string	Coding Agent	Subfield denotes the second level category, Default to AI AGENT, you can use choose detailed category, such as coding agent, deep research agent, etc. Please check the website
.content_tag_list	Optional	string	python,js,cli	-
.github	Optional	string	-	-
.thumbnail_picture	Optional	string	url	Support single image url. This will be used to display as thumbnail icon
.upload_image_files	Optional	string	url1,url2,url3	Support multiple image urls, seperated by comma.
.api	Optional	string	-	The API Endpoint supports GET/POST method and allow OneKey Router to post to
.price_type	Optional	string	PER_CALL	Enum: FREE,PER_CALL,FIXED,SUBSCRIPTION
.price_per_call_credit	Optional	double	500	Credits per one thousands calls (credits/1k Calls), The credit you expect to receive if your API endpoint is successfully called and routed by OneKey Router from user’s query
.price_fixed_credit	Optional	double	1000	Credits you expect to receive from one-time purchase, usually applicable to datasets, etc.
.price_subscription	Optional	string	-	The json string of your subscription plan, such as {“base”: “”, “premium-monthly”: “”, “premium-yearly”}

NodeJS API

See for GitHub of agtm for more details.

Search by Unique ID

The unique id of agent meta usually follows the github or nodejs schema, such as unique_id=”{owner}/{repo_name}”

Parameter	type	value
id	string	unique id of the item, unique_id=”{owner}/{repo_name}”
return_fields	string	optinal, e.g. return_fields=tools,config

List Mode

http

GET /api/ai_agent_marketplace/v2?mode=list&id=google-maps/google-maps

Curl

curl 'https://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=list&id=google-maps/google-maps'

Dict Mode

http

GET /api/ai_agent_marketplace/v2?mode=dict&id=google-maps/google-maps

Curl

curl 'https://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=dict&id=google-maps/google-maps'

Search by Query

Parameter	type	value
query	string	string of query
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
return_fields	string	optinal, e.g. return_fields=tools,config

List Mode

http

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

Curl

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

Dict Mode

http

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

Curl

curl 'https://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=dict&query=coding agent&page_id=0&count_per_page=5'

Pagination Exploration with No Query

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

List Mode

http

GET /api/ai_agent_marketplace/v2?mode=list&page_id=0&count_per_page=5

Curl

curl 'https://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=list&page_id=0&count_per_page=5'

Dict Mode

http

GET /api/ai_agent_marketplace/v2?mode=dict&page_id=0&count_per_page=5

Curl

curl 'https://www.deepnlp.org/api/ai_agent_marketplace/v2?mode=dict&page_id=0&count_per_page=5'

API V1

GET /api/ai_agent_marketplace/v1?q=coding agent&limit=20

Curl

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"    
}