POST/v1/push/sources/{source_id}/documents

Trimite un document (creare sau înlocuire)

push_upsert_document

Creează sau înlocuiește un document după external_id. Cu JSON, trimiteți conținutul în content (content_type: html, markdown sau text, cel mult 5 MB). Cu multipart/form-data, trimiteți fișierul în partea file (cel mult 100 MB, aceleași formate ca la o încărcare în baza de cunoștințe) și metadatele în partea document (JSON cu aceeași formă, fără content) sau ca câmpuri separate external_id, title, url, path, tags. sync_number este numărul sincronizării deschise. Fără el, documentul este scris imediat (scriere directă), dar următoarea sincronizare completă îl șterge, dacă nu este trimis din nou. Trimiterea din nou a aceluiași document returnează unchanged (idempotent). Documentul devine fișă la următoarea sincronizare a sursei (în cel mult un minut; în cadrul unei sincronizări deschise – după închiderea ei). Începând cu 1.62.0: câmpuri ale fișei (metadata, category, verifiers, verify_interval_days), un fișier dintr-o încărcare în părți (upload_id) și atașamente (attachments); răspunsul include status și card_id (rezultatul documentului). Limita de documente a unei surse depinde de plan.

Autentificare

Trimiteți o cheie API în antetul Authorization: Authorization: Bearer <cheie>.

Parametri de cale

source_idintegerobligatoriu

Parametri de interogare

sync_numberinteger

Parametri de antet

Idempotency-Keystring
Cheie pentru reîncercarea sigură a unei scrieri: 1–255 de caractere ASCII imprimabile; se recomandă un UUID v4 pentru fiecare operație logică. O reîncercare cu aceeași cheie în decurs de 24 de ore nu execută din nou operația: returnează răspunsul salvat (status, antete și corp) cu antetul Idempotency-Replayed: true. Aceeași cheie cu altă metodă, altă cale, alt Content-Type sau alt corp returnează 409 api.idempotency_mismatch; cât timp prima cerere încă rulează – 409 api.idempotency_in_progress cu Retry-After: 1. După un răspuns 5xx sau 429, cheia este eliberată, iar o reîncercare execută din nou operația. Cheia este valabilă în cadrul organizației și al apelantului (cheie API, utilizator sau cheie de sursă personalizată).
length ≥ 1, length ≤ 255

Corpul cererii

application/json

Obiect: PushDocument

external_idstringobligatoriu
ID-ul stabil al documentului. Trimiterea aceluiași ID înlocuiește documentul.
length ≤ 512
titlestringobligatoriu
length ≤ 500
urlstring
Linkul către document în sistemul dumneavoastră (http sau https).
contentstring
Conținutul (cel mult 5 MB).
content_typestring
Valori permise: htmlmarkdowntext
Implicit: "html"
patharray of string | string
Dosarele documentului: un tablou de nume sau un șir separat prin „/” (cel mult 10 niveluri).
permissionsPushPermissions
tagsarray of string
items ≤ 50
author_emailstring
Autorul. Devine responsabilul fișei dacă este un utilizator Sursa.
updated_atstring (date-time)
Momentul modificării în sistemul dumneavoastră (parte a versiunii documentului).
metadataMetadataPatch
metadata ale fișei documentului (din 1.62.0): obiectul îl înlocuiește pe cel anterior al fișei, {} elimină toate perechile; fără câmpul metadata, metadatele fișei nu se modifică.
categorystring
Categoria fișei: cheia unei categorii a organizației (GET /v1/categories), din 1.62.0.
length ≤ 64
verifiersPushVerifiers
verify_interval_daysinteger
Intervalul de verificare al fișei, în zile (din 1.62.0); fără el, intervalul sursei.
≥ 1, ≤ 3650
upload_idstring
Fișierul documentului dintr-o încărcare în părți (upl_…, din 1.62.0) în loc de content. O încărcare se folosește o singură dată; retrimiterea aceluiași document cu același upload_id nu o consumă. Cât timp încărcările în părți nu sunt disponibile în instalare, documentul este respins cu motivul file_rejected.
length ≤ 64
attachmentsarray of string
Atașamentele documentului ca încărcări în părți (upl_…, din 1.62.0): fiecare devine o fișă separată a sursei, cu același dosar, aceleași permisiuni și aceleași câmpuri ale fișei. Un atașament care lipsește dintr-o versiune nouă a documentului se arhivează.
items ≤ 20

multipart/form-data

filestring (binary)obligatoriu
documentstring
Metadatele JSON ale documentului (câmpurile PushDocument fără content).
external_idstring
titlestring
urlstring
pathstring
tagsstring

Răspunsuri

200Scris

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.
Idempotency-Replayed
true înseamnă că răspunsul a fost redat din cel salvat pentru această cheie Idempotency-Key: operația nu a rulat din nou.

application/json

Obiect: PushDocumentResult

external_idstringobligatoriu
resultstringobligatoriu
skipped: un document dintr-un lot atomic nu a fost aplicat deoarece un alt document a fost respins (din 1.62.0).
Valori permise: createdupdatedunchangeddeletednot_founderrorskipped
versionstring
Versiunea documentului (SHA-256 al conținutului și al metadatelor).
errorstring
Motivul (când result = error).
statusPushDocumentStatusValue
card_idstring | null
Fișa documentului, dacă a fost deja scrisă (din 1.62.0).
reasonPushDocumentReason

400Cererea este invalidă: valoarea unui parametru sau starea obiectului nu permite acțiunea (`detail` este un mesaj).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

401Nu au fost trimise date de autentificare (nici cookie de sesiune, nici cheie API) sau cheia nu a fost găsită.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

403Acțiunea nu este permisă: rolul este insuficient, nu există acces la colecție sau la fișă, cererea rulează în modul „View as” (vizualizare ca alt utilizator) sau organizația este suspendată ori ștearsă (`detail` este un obiect cu `code: org_suspended | org_deleted`).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

404Obiectul nu există sau nu vă este disponibil. API-ul nu confirmă existența unui obiect restricționat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

409Starea obiectului nu permite acțiunea, de exemplu o dublură, o indexare în curs sau un job deja procesat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

413Corpul cererii depășește dimensiunea permisă.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

415Formatul fișierului nu este acceptat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

422Eroare de validare: corpul sau parametrii nu corespund schemei (`detail` este o listă de erori de validare) ori valoarea unui parametru este în afara intervalului permis (`detail` este un mesaj).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

429Prea multe cereri (`api.rate_limited`), cota organizației pentru minut, zi sau lună este epuizată (`api.quota_exceeded`; `error.details` conține `quota`, `limit` și `reset_at`), limita organizației este atinsă sau serviciul de răspunsuri este ocupat (`answers.engine_busy`). Așteptați timpul indicat în antetul `Retry-After`.

Antetele răspunsului

Retry-After
Numărul de secunde de așteptat înainte de a reîncerca cererea.
RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

Coduri de eroare

Codurile pe care acest endpoint le poate returna în error.code, pe lângă codurile generale ale oricărei cereri.

Reîncercări sigure

Trimiteți un antet Idempotency-Key (de exemplu, un UUID) cu fiecare POST și PATCH. O reîncercare cu aceeași cheie în decurs de 24 de ore returnează răspunsul salvat, fără să execute din nou cererea.

Limite de frecvență

Răspunsurile conțin antetele RateLimit și RateLimit-Policy, precum și antetele anterioare X-RateLimit-Limit, X-RateLimit-Remaining și X-RateLimit-Reset. Un răspuns 429 conține Retry-After în secunde: așteptați și reîncercați.

← sources · Referința API

curl -X POST 'https://api.sursa.com/v1/push/sources/1/documents' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"external_id":"crm-1042","title":"Refund policy"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Încercați

Cheie API

Cheia rămâne în memoria acestei file a browserului și este trimisă doar către https://api.sursa.com.

Cererile se execută pe datele reale ale organizației.

Idempotency-Key header

source_id path *

sync_number query

Idempotency-Key

Dacă acest câmp este gol, pentru fiecare cerere se generează o cheie nouă.

Corpul cererii (JSON)