ONoneuptime
AI Agent

Get AI Agent

Endpoint to retrieve a single AI Agent by ID

post/ai-agent/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the AI Agent to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "key": true,
    "name": true,
    "description": true,
    "connectionStatus": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "key": "Example short text",
    "name": "My AI Agent",
    "description": "This is a description of the item",
    "slug": "example-slug-value",
    "aiAgentVersion": {
      "_type": "Version",
      "value": "1.0.0"
    },
    "lastAlive": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "iconFileId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "connectionStatus": "connected",
    "isDefault": true,
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.