POST/v1/drafts

Tworzenie szkicu

create_draft

Tworzy szkic nowej karty (collection, wymaga COLLECTION_CREATE_CARDS) lub edycji istniejącej karty (card_id, wymaga CARD_EDIT; tytuł, tagi i tekst są brane z najnowszej wersji, jeśli ich nie podano). Autor jest pierwszym współautorem. Użytkownik może mieć jeden aktywny szkic na kartę: powtórzone żądanie zwraca 409 drafts.exists z draft_id w details (kontynuuj w tym szkicu przez PATCH). scheduled_publish_at planuje publikację. Klucz API wskazuje autora szkicu w author_id (od wersji 1.62.0).

Uwierzytelnianie

Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.

Parametry nagłówka

Idempotency-Keystring
Klucz bezpiecznego ponowienia zapisu: od 1 do 255 drukowalnych znaków ASCII; zalecany jest UUID v4 na każdą operację logiczną. Ponowienie z tym samym kluczem w ciągu 24 godzin nie wykonuje operacji ponownie: zwraca zapisaną odpowiedź (status, nagłówki i treść) z nagłówkiem Idempotency-Replayed: true. Ten sam klucz z inną metodą, ścieżką, Content-Type lub treścią zwraca 409 api.idempotency_mismatch; dopóki pierwsze żądanie jest jeszcze wykonywane – 409 api.idempotency_in_progress z Retry-After: 1. Po odpowiedzi 5xx lub 429 klucz zostaje zwolniony, a ponowienie wykonuje operację jeszcze raz. Klucz obowiązuje w obrębie organizacji i wywołującego (klucz API, użytkownik lub klucz własnego źródła).
length ≥ 1, length ≤ 255

Treść żądania

application/json

Obiekt: DraftCreate

card_idstring | null
collectionstring | null
Nazwa kolekcji dla nowej karty (wymagana bez card_id).
titlestring | null
length ≤ 200
body_markdownstring | null
length ≤ 500000
tagsarray of string | null
items ≤ 30
revision_notestring | null
length ≤ 1000
verify_on_publishboolean
Domyślnie: false
notify_followersboolean
Domyślnie: false
scheduled_publish_atstring (date-time) | null
author_idinteger
Autor szkicu, gdy wywołuje klucz API (od 1.62.0): aktywny użytkownik organizacji klucza; użytkownik staje się created_by i pierwszym współautorem. Wymagany dla klucza (w przeciwnym razie 422 validation.failed); użytkownik innej organizacji lub nieaktywny użytkownik zwraca 404 users.not_found. Uprawnienia do kolekcji i karty są sprawdzane dla klucza, nie dla autora. W sesji autorem jest zalogowany użytkownik: inny author_id zwraca 422 validation.failed.
≥ 1

Odpowiedzi

201Utworzono

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.
Idempotency-Replayed
true oznacza, że odpowiedź została odtworzona z odpowiedzi zapisanej dla tego Idempotency-Key: operacja nie została wykonana ponownie.

application/json

Obiekt: Draft

idintegerwymagane
org_idintegerwymagane
card_idstring | nullwymagane
Karta edytowana w szkicu; null – szkic nowej karty.
collection_idintegerwymagane
collectionstringwymagane
titlestringwymagane
body_markdownstringwymagane
tagsarray of stringwymagane
base_versioninteger | null
Wersja karty, od której zaczęto szkic.
scheduled_publish_atstring (date-time) | null
workflow_stateDraftWorkflowStatewymagane
revision_notestring | null
verify_on_publishbooleanwymagane
notify_followersbooleanwymagane
created_byintegerwymagane
updated_byinteger | null
created_atstring (date-time)wymagane
updated_atstring (date-time)wymagane
publish_requested_byinteger | null
publish_requested_atstring (date-time) | null
approved_byinteger | null
approved_atstring (date-time) | null
collaboratorsarray of DraftCollaboratorwymagane
conflictstring | null
card_published – karta została opublikowana lub zmieniona po rozpoczęciu szkicu; card_deleted – karta została usunięta; lista rozszerzalna.

400Żądanie jest nieprawidłowe: wartość parametru lub stan obiektu nie pozwala na to działanie (`detail` zawiera komunikat).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

401Nie przesłano danych uwierzytelniających (ani pliku cookie sesji, ani klucza API) lub nie znaleziono klucza.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

403Działanie jest niedozwolone: rola jest niewystarczająca, brak dostępu do kolekcji lub karty, żądanie jest wykonywane w trybie „View as” albo organizacja jest zawieszona lub usunięta (`detail` to obiekt z `code: org_suspended | org_deleted`).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

404Obiekt nie istnieje lub nie jest dla Ciebie dostępny. API nie potwierdza istnienia obiektu z ograniczonym dostępem.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

409Stan obiektu nie pozwala na to działanie, np. duplikat, trwające indeksowanie lub zadanie, które zostało już przetworzone.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

422Błąd walidacji: treść lub parametry nie odpowiadają schematowi (`detail` to lista błędów walidacji) albo wartość parametru jest poza zakresem (`detail` zawiera komunikat).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

429Zbyt wiele żądań (`api.rate_limited`), wyczerpano przydział organizacji na minutę, dzień lub miesiąc (`api.quota_exceeded`; `error.details` zawiera `quota`, `limit` i `reset_at`), osiągnięto limit organizacji albo usługa odpowiedzi jest zajęta (`answers.engine_busy`). Odczekaj czas podany w nagłówku `Retry-After`.

Nagłówki odpowiedzi

Retry-After
Liczba sekund oczekiwania przed ponowieniem żądania.
RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

Kody błędów

Kody, które ta operacja może zwrócić w error.code, oprócz ogólnych kodów każdego żądania.

Bezpieczne ponawianie

Wysyłaj nagłówek Idempotency-Key (na przykład UUID) z każdym żądaniem POST i PATCH. Ponowienie z tym samym kluczem w ciągu 24 godzin zwraca zapisaną odpowiedź, zamiast ponownie wykonywać żądanie.

Limity częstotliwości

Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.

← drafts · Dokumentacja API

curl -X POST 'https://api.sursa.com/v1/drafts' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"collection":"support","title":"Refund policy","body_markdown":"# Refund policy\n\nRefunds are processed within 14 days.","author_id":1}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Wypróbuj

Klucz API

Klucz zostaje w pamięci tej karty przeglądarki i jest wysyłany tylko do https://api.sursa.com.

Żądania działają na prawdziwych danych Twojej organizacji.

Idempotency-Key header

Idempotency-Key

Gdy to pole jest puste, dla każdego żądania generowany jest nowy klucz.

Treść żądania (JSON)