---
title: "Get agent definition"
method: GET
path: "/agent-repository/agent-definitions/{agentDefinitionId}"
tags: ["Agent Definitions"]
---

# Get agent definition

`GET /agent-repository/agent-definitions/{agentDefinitionId}`

## Request

- Base URL: `http://localhost:8090/agent-api`
- URL: `http://localhost:8090/agent-api/agent-repository/agent-definitions/{agentDefinitionId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/docs/agent-repository/agent-definitions/:agentDefinitionId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `agentDefinitionId` string, required

## Response `200`

Indicates the agent definition was found and returned.

- AgentDefinitionResponse: The response for an agent definition
  - `id` string, required: The unique identifier of an agent definition
  - `key` string, required: The key of the agent definition
  - `name` string, required: The name of the agent definition
  - `version` integer, required: The version of the agent definition
  - `deploymentId` string: The deployment id of the agent definition
  - `tenantId` string: The tenant id of the agent definition
  - `resourceName` string: The resource name of the agent definition
  - `description` string: The description of the agent definition
  - `type` string: The type for the agent definition
  - `apiEnabled` boolean: Whether the agent definition is enabled for API usage

## Other responses

- `403`: Indicates the user does not have the rights to query for the agent definition.
- `404`: Indicates the requested agent definition was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/revisions/54fc1189496f?raw)