Agent Test API (Update / Release)

Allows developers to use AI tools such as CodeX and Claude (with the GPTBots Agent Skill installed) to import the .bot file configuration generated by Skills into a target Agent on the GPTBots platform and release it to production.

⚠️ Only Agents in "test mode" can be called. Calling an Agent in production mode returns 403200. Test mode is selected when creating an Agent and cannot be changed after creation.

Agent Update API (Import .bot to replace the current version)

Imports the .bot file into the target Agent (test mode), and saves the replaced current configuration as a new draft version (which also becomes the "current version"). The specific rules are as follows:

• Knowledge bases (data groups) / database tables / knowledge documents: scoped by AgentID; those still belonging to the target Agent are retained, otherwise discarded;
• Linked workflows / tools (plugins): scoped by organization; those still valid are retained, otherwise discarded;
• Top-level knowledge base mounts are not exported with the .bot; on import, the knowledge bases already mounted on the target Agent itself are retained;
• Third-party credentials: when importing into an existing Agent, credentials already configured on the target are backfilled by "identical component/node/plugin ID", without clearing already-authenticated components, to ensure availability;

Request Method

POST

Request URL

https://api-${endpoint}.gptbots.ai/v1/agent/version/import

Request

Request Example

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/version/import' \
-H 'Authorization: Bearer {AGENT_API_KEY}' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@my-agent.bot' \
-F 'versionDesc=Imported by AI tool'

                    

Request Headers

Request Parameters

The version number is generated automatically by the server (the last segment of the latest version +1; if there is no version history, it is 1.0.0).

Response

Response Example

                      
                      {
  "code": 0,
  "msg": "OK",
  "data": {
    "botId": "xxx",
    "botType": "QuestionAnswer",
    "version": "1.0.3"
  }
}

                    

Success Response

Failure Response

Agent Release API (Release a version number to production)

Releases the specified version number of the target Agent (test mode) as the live production version (that version becomes "live", and the other versions revert to draft state).

Request Method

POST

Request URL

https://api-${endpoint}.gptbots.ai/v1/agent/version/release

Request

Request Example

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/version/release' \
-H 'Authorization: Bearer {AGENT_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
        "version": "1.0.3"
}'

                    

Request Headers

Request Parameters

Response

Response Example

                      
                      {
  "code": 0,
  "msg": "OK"
}

                    

Success Response

No data body; a code of 0 means the release succeeded.

Failure Response

Error Codes

The Update and Release APIs share the same set of error codes: