Каталог шагов обработки

Возвращает список всех доступных атомарных шагов обработки с параметрами, категориями и типами ввода. Используйте для динамического построения пайплайнов.

GET
/steps

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Query Parameters

categorystring

Фильтр по категории шага

Value in: "source" | "media" | "text" | "photo" | "system"
input_typestring

Фильтр по типу входных данных

Value in: "audio" | "video" | "text" | "image"

Response Body

Список шагов обработки

successboolean
dataarray<object>

Ошибка валидации запроса. Тело запроса не соответствует схеме или содержит невалидные значения.

Поле errors содержит детализацию по каждому невалидному полю.

successRequiredboolean
errorRequiredobject
errorsarray<object>

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

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

КодПричинаЧто делать
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/steps?category=source&input_type=audio" \
  -H "Authorization: Bearer <token>"
fetch("/api/v1/steps?category=source&input_type=audio", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})
package main

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

func main() {
  url := "/api/v1/steps?category=source&input_type=audio"

  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/steps?category=source&input_type=audio"

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

print(response.text)
{
  "success": true,
  "data": [
    {
      "name": "transcribe",
      "label": "Transcribe",
      "description": "string",
      "category": "source",
      "input_types": [
        "string"
      ],
      "requires_media": true,
      "produces": [
        "string"
      ],
      "typical_dependencies": [
        "string"
      ],
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "description": "string",
          "required": true,
          "default": null
        }
      ]
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request body"
  },
  "errors": [
    {
      "field": "url",
      "message": "Укажите url или input"
    }
  ]
}

{
  "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"
  }
}