Skip to main content
POST
/
v1
/
agents
/
{agent_id}
/
deploy
Deploy agent
curl --request POST \
  --url https://api.callrounded.com/v1/agents/{agent_id}/deploy \
  --header 'X-Api-Key: <api-key>'
{
  "data": {
    "version": 123,
    "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "message": "Agent deployed successfully",
  "error": {
    "details": [
      {
        "field": "email",
        "message": "Invalid email format"
      }
    ],
    "message": "An error occurred while processing your request",
    "status": 400,
    "type": "generic_error"
  },
  "status": 200
}

Authorizations

​
X-Api-Key
string
header
required

The API Key created in Rounded Studio.

Path Parameters

​
agent_id
string<uuid>
required

The ID of the agent to deploy.

Query Parameters

​
version
integer | null

The configuration version of the agent to deploy. If not provided, the latest draft version is deployed.

Response

Successfully deployed agent configuration version

​
data
AgentDeployApiResponseData · object
required

The deployed agent basic data.

​
message
string
default:Agent deployed successfully

Response message indicating the result of the operation.

​
error
ApiResponseError · object
Example:
{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}
​
status
integer
default:200

HTTP status code of the response.