API-справочник

REST API для генерации и скачивания креатив-паков.

Подключайте серверную интеграцию через ключи доступа, Swagger-совместимую схему и оплачиваемый цикл запроса креатив-пака.

Открыть JSON-схему Быстрый старт

Контракт запуска

Адресhttps://formatry.cc

OpenAPI/api/v1/openapi.json

Версия2026-06-18

АвторизацияAuthorization: Bearer <api-key> или X-API-Key: <api-key>

Передача дизайнеру

СоздатьСоздайте серверный ключ с нужными правами из кабинета или через управленческий ключ.

ХранитьПередавайте секрет через менеджер паролей или серверное хранилище секретов; не сохраняйте его в репозитории и не вставляйте в клиентский код.

ОграничитьДайте дизайнеру только права на баланс, загрузки, задания, готовые файлы и проверку истории.

МенятьОтзывайте старый ключ и создавайте новый при смене владельца интеграции.

Открыть ключи аккаунта

Swagger и REST

Импортируйте схему, затем проверьте запросом баланса.

Swagger/OpenAPI URL
https://formatry.cc/api/v1/openapi.json

Импортируйте URL в Swagger UI, Postman, Insomnia или генератор кода OpenAPI.

FORMATRY_CC_ORIGIN=https://formatry.cc
FORMATRY_CC_API_KEY=<секретный ключ, показанный один раз при создании>

curl "$FORMATRY_CC_ORIGIN/api/v1/balance" \
  -H "Authorization: Bearer $FORMATRY_CC_API_KEY"

Маршруты

REST-маршруты из текущей OpenAPI-схемы.

POST/api/v1/codex/trial-key

Claim a temporary Codex plugin trial key.

Схема

GET/api/v1/balance

Read the workspace credit balance for the API key.

Ключ доступа

GET/api/v1/usage

List recent workspace usage ledger events.

Ключ доступа

GET/api/v1/api-keys

List workspace API keys without exposing secrets.

Ключ доступа

POST/api/v1/api-keys

Create a workspace API key and return its secret once.

Ключ доступа

DELETE/api/v1/api-keys/{apiKeyId}

Revoke one workspace API key.

Ключ доступа

GET/api/v1/assets

List workspace assets visible to new generation jobs.

Ключ доступа

GET/api/v1/assets/{assetId}

Read one workspace asset by id.

Ключ доступа

DELETE/api/v1/assets/{assetId}

Soft-delete one workspace asset.

Ключ доступа

POST/api/v1/assets/uploads

Create an upload intent for a workspace asset.

Ключ доступа

POST/api/v1/assets/uploads/{uploadId}/complete

Verify a previously uploaded object and mark the asset ready.

Ключ доступа

PUT/api/v1/assets/uploads/{uploadId}/object

Upload bytes for a pending workspace asset.

Ключ доступа

PUT/api/v1/assets/upload-object

Upload bytes through the proxy URL returned by an upload intent.

Ключ доступа

GET/api/v1/previews/quota

Read the effective protected-preview allowance and policy.

Ключ доступа

POST/api/v1/previews

Create one bounded protected PNG preview.

Ключ доступа

GET/api/v1/jobs

List workspace-owned generation jobs.

Ключ доступа

POST/api/v1/jobs

Create a paid pack request and reserve workspace balance once.

Ключ доступа

GET/api/v1/jobs/{jobId}

Read workspace-owned generation job status.

Ключ доступа

POST/api/v1/jobs/{jobId}/cancel

Cancel a queued generation job and release reserved balance.

Ключ доступа

GET/api/v1/artifacts/{artifactId}

Read the artifact family for a workspace-owned generation job.

Ключ доступа

GET/api/v1/artifacts/{artifactId}/download

Get short-lived signed artifact download information.

Ключ доступа

GET/api/v1/artifacts/{artifactId}/files/{fileId}/download

Download one ready artifact file through scoped API authentication.

Ключ доступа