Ресурс

AI Agent Task

Manage tasks assigned to AI agents. Tasks can be scheduled, monitored, and tracked for completion.

Модель AI Agent Task

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
ProjectОбязательно
Описание
Project this task belongs to.
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of the project this task belongs to.
Имя
name
Тип
Very Long TextОбязательно
Описание
Name of the AI Agent Task.
Имя
description
Тип
Very Long TextОбязательно
Описание
Description of the AI Agent Task.
Имя
aiAgent
Тип
AI Agent
Описание
AI Agent assigned to this task.
Имя
aiAgentId
Тип
Object ID
Описание
ID of the AI Agent assigned to this task.
Имя
taskType
Тип
TextОбязательно
Описание
Type of task to be performed by the AI agent.
Имя
status
Тип
TextОбязательно
Описание
Current status of the task.
Имя
statusMessage
Тип
Long Text
Описание
A message describing the current status or result of the task.
Имя
metadata
Тип
JSON
Описание
Task-specific metadata containing context for the AI agent. Structure varies based on task type.
Имя
startedAt
Тип
Date
Описание
When the task started execution.
Имя
completedAt
Тип
Date
Описание
When the task completed execution.
Имя
createdByUser
Тип
User
Описание
Имя
createdByUserId
Тип
Object ID
Описание
User ID who created this object (if this object was created by a User)
Имя
taskNumber
Тип
NumberОбязательно
Описание
A unique, sequential number assigned to each AI Agent Task within a project.

GETorPOST/api/ai-agent-task/get-list

Список

Этот метод возвращает постраничный список ваших объектов «AI Agent Task». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать AI Agent Task, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/ai-agent-task/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "description": true,
    "name": true,
    "project": true,
    "projectId": true,
    "status": true
  },
  "query": {
    "description": "Example description"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37695450-28fe-11f1-b591-3fdcef396aba",
      "description": "Example description",
      "name": "Example name",
      "project": "Example project",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "37697b60-28fe-11f1-b591-3fdcef396aba",
      "description": "Example description",
      "name": "Example name",
      "project": "Example project",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "37697b61-28fe-11f1-b591-3fdcef396aba",
      "description": "Example description",
      "name": "Example name",
      "project": "Example project",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    }
  ]
}

GETorPOST/api/ai-agent-task/:id/get-item

Получить по ID

Возвращает объект «AI Agent Task» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/ai-agent-task/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "description": true,
    "name": true,
    "project": true,
    "projectId": true,
    "status": true
  }
}

Ответ

{
  "_id": "37695450-28fe-11f1-b591-3fdcef396aba",
  "description": "Example description",
  "name": "Example name",
  "project": "Example project",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status"
}

POST/api/ai-agent-task/count

Количество

Возвращает количество ваших объектов «AI Agent Task».

Необязательное тело запроса

query
Чтобы фильтровать AI Agent Task, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/ai-agent-task/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "description": "Example description"
  }
}

Ответ

{
  "count": 107
}

POST/api/ai-agent-task

Создать AI Agent Task

Создаёт новый объект.

Запрос создания

POST

/api/ai-agent-task

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "description": "Example description",
    "name": "Example name",
    "project": "Example project",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "Example status"
  }
}

Ответ

{
  "_id": "37695450-28fe-11f1-b591-3fdcef396aba",
  "description": "Example description",
  "name": "Example name",
  "project": "Example project",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status"
}

PUT/api/ai-agent-task/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/ai-agent-task/:id/update-item

GET/api/ai-agent-task/:id/update-item

Запрос обновления

PUT

/api/ai-agent-task/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "description": "Example description",
    "name": "Example name",
    "status": "Example status"
  }
}

Ответ

{}

DELETE/api/ai-agent-task/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/ai-agent-task/:id/delete-item

GET/api/ai-agent-task/:id/delete-item

Запрос удаления

DELETE

/api/ai-agent-task/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения AI Agent Task

Project Owner
Project Admin
Project Member
Read AI Agent Task
Read All Project Resources

Права на создание

Нужны для создания AI Agent Task

Project Owner
Project Admin
Project Member
Create AI Agent Task

Права на обновление

Нужны для обновления AI Agent Task

Project Owner
Project Admin
Project Member
Edit AI Agent Task

Права на удаление

Нужны для удаления AI Agent Task

Project Owner
Project Admin
Project Member
Delete AI Agent Task