# index

Endpoint: GET /api/agents
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `include` (string)
    Example: "createdBy,updatedBy"

  - `sort` (string)
    Example: "id"

## Response 200 fields (application/vnd.api+json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.type` (string, required)

  - `data.links` (object, required)

  - `data.links.self` (string, required)

  - `data.attributes` (object, required)

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.projectId` (string, required)

  - `data.attributes.name` (string, required)

  - `data.attributes.systemPrompt` (string, required)

  - `data.attributes.starterMessage` (string,null, required)

  - `data.attributes.modelType` (string, required)

  - `data.attributes.maxToolIterations` (integer, required)

  - `data.attributes.temperature` (number, required)

  - `data.attributes.reasoningEffort` (string, required)
    Enum: "NONE", "MINIMAL", "LOW", "MEDIUM", "HIGH"

  - `data.attributes.isManaged` (boolean, required)

  - `data.attributes.outputs` (array, required)

  - `data.attributes.outputs.name` (string, required)

  - `data.attributes.outputs.functionName` (string, required)

  - `data.attributes.outputs.functionDescription` (string,null, required)

  - `data.attributes.outputs.jsonSchema` (string, required)

  - `data.attributes.outputs.artifactType` (string,null, required)
    Enum: "IMAGE_ID_OUTPUT", "MARKDOWN_TEXT_OUTPUT", "REACT_OUTPUT", "PRESENTATION"

  - `data.attributes.outputs.artifactContentType` (string,null, required)
    Enum: same as `data.attributes.outputs.artifactType` (4 values)

  - `data.attributes.tools` (array, required)

  - `data.attributes.tools.toolTargetId` (string, required)

  - `data.attributes.tools.targetFunction` (string, required)

  - `data.attributes.tools.functionName` (string, required)

  - `data.attributes.tools.functionDescription` (string,null, required)

  - `data.attributes.tools.agentOutputMode` (string, required)
    Enum: "RETURN", "SHOW"

  - `data.attributes.tools.agentPromptSchema` (string,null, required)

  - `data.attributes.tools.agentPromptTemplate` (string,null, required)

  - `data.attributes.tools.toolTargetType` (string, required)

  - `data.attributes.tools.inheritChatFiles` (boolean, required)

  - `data.attributes.tools.targetType` (string, required)

  - `data.attributes.tools.targetKnowledgeBaseId` (string,null, required)

  - `data.attributes.tools.targetAgentId` (string,null, required)

  - `data.attributes.variables` (array, required)

  - `data.attributes.variables.name` (string, required)

  - `data.attributes.variables.toolTargetId` (string, required)

  - `data.attributes.variables.targetFunction` (string, required)

  - `data.attributes.variables.functionArgumentsText` (string,null, required)

  - `data.attributes.variables.toolTargetType` (string, required)

  - `data.attributes.variables.targetKnowledgeBaseId` (string,null, required)

  - `data.relationships` (object)

  - `data.relationships.overview` (object)

  - `data.relationships.overview.data` (object, required)

  - `data.relationships.overview.data.type` (string, required)

  - `data.relationships.overview.data.id` (string, required)

  - `data.relationships.createdBy` (object)

  - `data.relationships.createdBy.data` (object, required)

  - `data.relationships.createdBy.data.type` (string, required)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.updatedBy` (object)

  - `data.relationships.updatedBy.data` (object, required)

  - `data.relationships.updatedBy.data.type` (string, required)

  - `data.relationships.updatedBy.data.id` (string, required)

  - `meta` (object, required)

  - `meta.total` (integer, required)

  - `links` (object, required)

  - `links.first` (string, required)

  - `links.last` (string, required)

  - `included` (array)

  - `included.id` (string, required)

  - `included.type` (string, required)

  - `included.attributes` (object, required)

  - `included.attributes.firstReferencingAgentName` (string,null)

  - `included.attributes.firstReferencedByAgentName` (string)

  - `included.attributes.firstReferencedByPromptName` (string,null)

  - `included.attributes.totalReferencingAgentCount` (integer)

  - `included.attributes.totalReferencedByAgentCount` (integer)

  - `included.attributes.totalReferencedByPromptCount` (integer)

  - `included.attributes.name` (string)

  - `included.attributes.email` (string)

## Response 401 fields (application/json):

  - `status` (string, required)

  - `error` (string, required)

## Response 403 fields (application/json):

  - `status` (string, required)

  - `error` (string, required)