ДемоЦеныДокументацияOn-premiseРешенияБлог
ЗадачиСписок задач

Список задач

Возвращает список задач текущего пользователя с пагинацией и фильтрацией по статусу.

GET
/tasks

Authorization

AuthorizationRequiredBearer <token>

API ключ для аутентификации. Передавайте в заголовке Authorization: Bearer sk-...

In: header

Query Parameters

limitinteger

Количество записей на странице

Default: 20Minimum: 1Maximum: 100
offsetinteger

Смещение от начала списка

Default: 0Minimum: 0
statusstring

Фильтр по статусу задачи

Value in: "pending" | "processing" | "completed" | "failed"

Response Body

Список задач

successboolean
dataobject

Ошибка аутентификации.

КодПричинаЧто делать
MISSING_API_KEYЗаголовок Authorization отсутствуетДобавьте Authorization: Bearer sk-...
INVALID_AUTH_FORMATНеверный формат заголовкаИспользуйте формат Bearer sk-...
INVALID_API_KEYКлюч не найден в системеПроверьте ключ в личном кабинете
API_KEY_INACTIVEКлюч деактивированАктивируйте ключ в личном кабинете
API_KEY_EXPIREDСрок действия ключа истёкСоздайте новый ключ
successRequiredboolean
errorRequiredobject
errorsarray<object>

Детализация ошибок валидации (при code=VALIDATION_ERROR)

Превышен лимит запросов для вашего тарифа. Повторите запрос через время, указанное в заголовке Retry-After.

Лимиты зависят от тарифа (см. раздел Тарифы в личном кабинете).

successRequiredboolean
errorRequiredobject
errorsarray<object>

Детализация ошибок валидации (при code=VALIDATION_ERROR)

curl -X GET "/api/v1/tasks?limit=20&offset=0&status=pending" \
  -H "Authorization: Bearer <token>"
fetch("/api/v1/tasks?limit=20&offset=0&status=pending", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "/api/v1/tasks?limit=20&offset=0&status=pending"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "/api/v1/tasks?limit=20&offset=0&status=pending"

response = requests.request("GET", url, headers = {
  "Authorization": "Bearer <token>"
})

print(response.text)
{
  "success": true,
  "data": {
    "tasks": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "pending",
        "input": {},
        "output": {},
        "error": "string",
        "webhook_url": "string",
        "expires_at": "2019-08-24T14:15:22Z",
        "expired": true,
        "metadata": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "completed_at": "2019-08-24T14:15:22Z"
      }
    ],
    "pagination": {
      "total": 0,
      "limit": 0,
      "offset": 0
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key is required. Pass it in Authorization header: Bearer sk-..."
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again in 12 seconds"
  }
}

Назад

Создать задачу

Далее

Пакетное создание задач