Datavju
Logg innSe ditt eget resultat
Velg språk
Datavju
Logg innSe ditt eget resultat
Velg språk

API

API gir en lagret Table eller et generert Data-resultat et HTTP-endepunkt som et annet program kan kalle. Bruk Read (GET) til å hente rader, eller Create (POST) på et Data-element til å kjøre det lagrede AI-oppsettet med angitte inndata. Hver forespørsel trenger Bearer Token som du setter opp i Datavju.

Aktiver og publiser et endepunkt

Start med en lagret Table, en støttet View eller et Data-element med genererte resultater. API-innstillingene tilhører det lagrede elementet og lagres når du endrer dem.

CSV har en Enable API-bryter, men ingen API Config i verktøylinjen. Lesing av en View bygget direkte fra en CSV-kilde gjennom dette API-et er ikke tilgjengelig ennå. Bruk en lagret Table i leseeksemplene nedenfor.

  1. Åpne elementet i Organizer. For en Table eller View velger du Show Table options hvis sidepanelet er lukket.
  2. Slå på Enable API. Dette oppretter et upublisert endepunkt med Read (GET) på og Create (POST) av.
  3. Velg API i verktøylinjen for å åpne API Config.
  4. Behold Domain Type → Datavju Domain og fyll inn Endpoint Path, for eksempel brief.
  5. Kopier Bearer Token til det kallende programmets private oppsett. Hold det utenfor offentlige sider og delte skjermbilder.
  6. Velg metodene du trenger. Behold Create (POST) av for vanlig lesing av en Table.
  7. Slå på Published når innstillingene er klare, og kall deretter Endpoint Preview med riktig metode og autorisasjonshode.
API Config ved siden av en lagret Structure Table med Published, endepunktstien brief og Read GET, og med Bearer Token skjult

Sett opp tilgang og metoder

Published og Enable API styrer tilgangen hver for seg. Published av beholder innstillingene, mens Enable API av fjerner dem.

  • Enable API - Standard: av. Slå på for å opprette API-innstillinger. Av fjerner innstillingene. Ny aktivering oppretter et nytt token og standardinnstillinger.
  • Published - Standard: av for et nytt API. Slå på etter at du har kontrollert tilgang og metoder. Slå av for å stoppe forespørsler og beholde oppsettet.
  • Domain Type - Standard: Datavju Domain. Behold dette for Datavjus API-vert. Use Own Domain endrer bare forhåndsvisningen. Ruting med eget domene er ikke tilgjengelig ennå.
  • Own Domain Name - Standard: tomt, vises for Use Own Domain. Endrer bare verten i forhåndsvisningen, for eksempel api.example.test. Uten angitt protokoll vises HTTPS.
  • Endpoint Path - Standard: tomt. Skriv en sti du husker, for eksempel brief. Når den er angitt, må forespørsler treffe den nøyaktig. Bruk en uttrykkelig sti slik at kallere har én avtalt URL.
  • Endpoint Preview - Standard: generert og skrivebeskyttet. Kopier hele URL-en, inkludert den lange elementidentifikatoren før stien. Endring av stien beholder identifikatoren.
  • Bearer Token - Standard: genereres automatisk. Erstatt det for å endre tokenet kallere må sende. Oppdater kallere etter at endringen er lagret. Et tomt felt hindrer autoriserte forespørsler.
  • Read (GET) - Standard: på. Returnerer rader med feltnavnene og opprinnelige JSON-verdier. Slå av hvis endepunktet bare skal kjøre Data-forespørsler.
  • Create (POST) - Standard: av. Slå på for Data-genereringsforespørselen nedenfor. Den kjører den lagrede Data-modellen og returnerer den første resultatraden.

Les rader med GET

Send nøyaktig HTTP-hode Authorization: Bearer. Å åpne URL-en i en vanlig nettleserfane sender ikke dette hodet.

Sett DATAVJU_API_URL til Endpoint Preview og DATAVJU_API_TOKEN til ditt private token. En vellykket GET returnerer en JSON-array, også når tabellen bare har én rad. En tabell uten rader returnerer en tom array.

Svaret kan inneholde strukturerte Object- og Array-felt. Kontroller selve JSON-svaret før du velger hvilke felt du skal bruke i et annet program.

curl --fail-with-body "$DATAVJU_API_URL" \
  --header "Authorization: Bearer $DATAVJU_API_TOKEN"

Kjør Data-generering med POST

POST bruker leverandøren, API-et, modellen og transformasjonene som allerede er lagret på et Data-element. Hvert kall gjør en ny genereringsforespørsel og kan gi leverandørbruk. Returverdien er den første transformerte resultatraden. Kallet beholder Data-elementets lagrede rader.

Alle de tre feltene på øverste nivå i forespørselsinnholdet er påkrevd. Ekstra felt avvises.

For Instructions og Input fra forespørselen åpner du editoren for hvert felt og velger Source → Text Input. Bruk deretter Generate én gang for å lagre oppsettet. En lagret Dataset-kilde med rader leverer feltet på nytt når kallet kjører, og overstyrer den innsendte verdien.

Felt i forespørselen

Angi hvert felt med den påkrevde JSON-typen.

  • instructions - String. For eksempel gir Extract item and quantity. instruksjoner for dette kallet når Source er Text Input.
  • input - Array. For eksempel gir en brukermelding med Please send 12 blue notebooks. inndata for kallet når Source er Text Input.
  • responseSchema - Object. Et JSON-skjema for item og quantity erstatter svarskjemaet for dette kallet.

Send en genereringsforespørsel

For et Data-element satt opp med OpenAI Responses lagrer du eksempelinnholdet nedenfor som request.json.

  1. Åpne det oppsatte Data-elementet, generer det første resultatet og aktiver API.
  2. Sett Endpoint Path, slå på Create (POST) og publiser det.
  3. Sett URL og token for dette Data-endepunktet, og send deretter forespørselen nedenfor.
  4. Kontroller det returnerte objektet mot skjemaet og de lagrede transformasjonene. Den lagrede leverandøren må støtte inndataene og skjemaet du sender.
{
  "instructions": "Extract item and quantity.",
  "input": [
    {"role": "user", "content": "Please send 12 blue notebooks."}
  ],
  "responseSchema": {
    "type": "object",
    "properties": {
      "item": {"type": "string"},
      "quantity": {"type": "number"}
    },
    "required": ["item", "quantity"],
    "additionalProperties": false
  }
}
curl --fail-with-body "$DATAVJU_API_URL" \
  --header "Authorization: Bearer $DATAVJU_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data @request.json

Eksempler

Disse eksemplene bruker en lagret Structure Table med ett dokument som heter Document. API-stien er brief og Read (GET) er på.

Les en dokumentoppføring

En Structure Table inneholder dokumentinnholdet som strukturert JSON sammen med Name og Created.

  1. Lagre beskrivelsen som en Structure Table i Structure, og åpne den nye tabellen i Organizer.
  2. Aktiver API, sett Endpoint Path til brief og slå på Published.
  3. Kjør GET-forespørselen ovenfor med denne tabellens URL og token.
  4. Les Name og Content fra den returnerte raden. I eksemplet er Name Document, Structure og Content er JSON-objekter, og Created er en tidsstempelstreng.

Gi et annet program bare feltene det trenger

Velg felt i programmet ditt etter at du har lest svaret. Å skjule en kolonne i tabellen fjerner ikke feltet fra dette API-svaret.

  1. Behold bearer-tokenet i serverens miljø.
  2. Kall endepunktet fra serveren med eksempelkoden.
  3. Bruk documentNames der du trenger listen over lagrede dokumentnavn.
const response = await fetch(process.env.DATAVJU_API_URL, {
  headers: {Authorization: `Bearer ${process.env.DATAVJU_API_TOKEN}`}
});
if (!response.ok) throw new Error(`API returned ${response.status}`);
const rows = await response.json();
const documentNames = rows.map(row => row.Name);
// Example: ["Document"]

Stopp tilgang og behold innstillingene

Bruk Published når du senere vil fortsette med samme sti og token.

  1. Åpne API → API Config og slå av Published.
  2. Gjenta en autorisert GET. Den returnerer 404 og ingen rader.
  3. Slå på Published for å fortsette. Et manglende eller feil bearer-token gir 401 selv når Published er på.
  4. For å erstatte et token endrer du Bearer Token, lar endringen lagres og oppdaterer deretter kalleren. Det forrige tokenet autoriserer ikke lenger forespørsler.

Begrensninger og vanlige feil

  • Bruk GET til å lese rader og POST til oppsatt Data-generering. PATCH, DELETE og vilkårlig innsetting av rader er ikke tilgjengelig gjennom dette API-et.
  • Behold bearer-tokener i privat serveroppsett. Nettleserkode som sendes til besøkende, avslører tilgangsopplysninger som ligger i koden.
  • Kopier hele Endpoint Preview. Både elementidentifikatoren og Endpoint Path er viktige.
  • Kontroller hvert returnerte felt. Å skjule en tabellkolonne utelater den ikke fra en direkte GET av en lagret Table.
  • Kontroller feil før du bruker et svar. 401 betyr at autorisasjonen feilet. 404 kan bety deaktivert, upublisert, feil sti eller en metode som er slått av.
  • En Transform View kan avvise GET med 400 når operasjonene ikke kan kompileres for dette endepunktet. Test det faktiske resultatet før du kobler til et annet program.
  • GET-resultater og data i en publisert Page kan støtte ulike operasjoner. Publisering av en Site publiserer ikke dette API-oppsettet.
  • Datagenerering - sett opp modellen, skjemaet og transformasjonene som POST bruker.
  • Structure - lagre et dokument som en strukturert Table.
  • Table - rediger lagrede rader og felt.
  • Site - publiser Pages for besøkende.
  • Schedule - oppdater lagrede data etter en tidsplan.