Skip to main content
Client Copy Agent
curl --request POST \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/copy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'
{
  "id": 123,
  "workspace_id": 123,
  "name": "<string>",
  "objective": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "n_runs": 123,
  "prompts": [
    {
      "created": "2025-01-01T00:00:00",
      "documents": [],
      "last_updated_by": "user@example.com",
      "name": "Account number",
      "options": {
        "code_generation": false,
        "prompt": "Find the account number",
        "type": "string",
        "web_search": false
      },
      "updated": "2025-01-01T00:00:00"
    },
    {
      "created": "2025-01-01T00:00:00",
      "documents": [],
      "last_updated_by": "user@example.com",
      "name": "Account info",
      "options": {
        "code_generation": false,
        "fields": [
          "full name",
          "address"
        ],
        "prompt": "Extract form fields",
        "type": "form",
        "web_search": false
      },
      "updated": "2025-01-02T00:00:00"
    }
  ]
}

​
Rate Limits

This endpoint is rate limited to 60 requests per minute per user.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>. The <token> represents your API key, which must be acquired from the Kolena platform.

Path Parameters

​
agent_id
integer
required

Body

application/json
​
name
string
required

Name of the agent to be created by copying the source agent.

​
target_workspace_id
integer | null

Optionally specify the workspace ID for the new agent.

​
target_folder_id
integer | null

Optionally specify the folder ID for the new agent.

Response

Successful Response

​
id
integer
required

The ID of this Agent.

​
workspace_id
integer
required

The ID of the workspace hosting this Agent.

​
name
string
required

The name of this Agent.

​
objective
string
required

A short description of this Agent's objective, e.g. "Extract key information from leases and addendum documents".

​
created
string<date-time>
required

When this Agent was created, formatted as an ISO 8601 timestamp (e.g. 2025-10-08T20:14:29.472247+00:00)

​
updated
string<date-time>
required

When this Agent was last updated, formatted as an ISO 8601 timestamp (e.g. 2025-10-08T20:14:29.472247+00:00)

​
created_by
string
required

The email address of the user who created this Agent.

​
n_runs
integer
required

The number of times this Agent has been Run.

​
prompts
Prompt · object[]
required

The Prompts configured for this Agent.

Examples:
[
  {
    "created": "2025-01-01T00:00:00",
    "documents": [],
    "last_updated_by": "user@example.com",
    "name": "Account number",
    "options": {
      "code_generation": false,
      "prompt": "Find the account number",
      "type": "string",
      "web_search": false
    },
    "updated": "2025-01-01T00:00:00"
  },
  {
    "created": "2025-01-01T00:00:00",
    "documents": [],
    "last_updated_by": "user@example.com",
    "name": "Account info",
    "options": {
      "code_generation": false,
      "fields": ["full name", "address"],
      "prompt": "Extract form fields",
      "type": "form",
      "web_search": false
    },
    "updated": "2025-01-02T00:00:00"
  }
]
⌘I